Commit Graph

19075 Commits

Author SHA1 Message Date
Takeshi KOMIYA
453e0c798e
Merge pull request #10100 from tk0miya/9413_xml_namespace
Fix #9413: xml: Invalid XML was generated when cross referencing python objects
2022-01-16 02:49:01 +09:00
Takeshi KOMIYA
d82d370739
Merge pull request #10078 from danieleades/refactor/unused-loop-control-variables
address some unused loop control variables
2022-01-16 02:46:32 +09:00
Takeshi KOMIYA
3b8387f469
Merge pull request #10097 from tk0miya/10029_strip_value_from_cmdoption
Fix #9981: std domain: Strip value part of the option directive from genindex
2022-01-16 02:44:24 +09:00
Takeshi KOMIYA
542db8ffb6
Merge pull request #10101 from Gobot1234/4.x
Fix empty returns section
2022-01-16 02:40:58 +09:00
James Hilton-Balfe
ff2105a2f3
Update tests/test_ext_napoleon_docstring.py 2022-01-15 17:31:23 +00:00
Takeshi KOMIYA
6a0215198f Merge branch '4.x' 2022-01-16 02:26:11 +09:00
Takeshi KOMIYA
76c9b3c605 Fix #9413: xml: Invalid XML was generated when cross referencing python objects 2022-01-16 02:02:12 +09:00
Takeshi KOMIYA
a55a765e79
Merge pull request #9661 from latosha-maltba/dedent
code-block: Fix handling of :dedent: and add unit tests
2022-01-16 02:00:40 +09:00
James Hilton-Balfe
d52adad64e Fix formatting 2022-01-15 14:04:38 +00:00
James Hilton-Balfe
dc60b1db76 Add a test for this 2022-01-15 13:59:25 +00:00
James Hilton-Balfe
4b8bb7b301 Only add returns section if there is something 2022-01-15 13:43:20 +00:00
Takeshi KOMIYA
ff54f97aba code-block: Pass list of strings ends with CR code to dedent_lines() 2022-01-15 20:35:21 +09:00
Takeshi KOMIYA
e2f141620d Fix a flake8 warning 2022-01-15 20:01:30 +09:00
Takeshi KOMIYA
44e6d0ce2a doc: Remove a mention to :dedent: 0
`:dedent: 0` option for the code-block directive is a secret feature.
So it should not be mentioned in our docs.
2022-01-15 19:59:47 +09:00
Takeshi KOMIYA
6611140c76 Merge branch '4.x' into HEAD 2022-01-15 19:46:45 +09:00
Takeshi KOMIYA
0938c193ea Update CHANGES for PR #10099 2022-01-15 15:18:36 +09:00
Takeshi KOMIYA
54159f66d3
Merge pull request #10099 from mgeier/skip-data-uris
Skip "data:" URIs in ImageConverter
2022-01-15 14:21:08 +09:00
jfbu
05ac877de7 LaTeX: same signature-description vertical space as for sig-sig 2022-01-14 20:18:07 +01:00
danieleades
9c68cd12d7
Update recipe.py 2022-01-14 08:58:54 +00:00
danieleades
18d7dfbd95
Update tests/test_ext_napoleon.py
Co-authored-by: Takeshi KOMIYA <i.tkomiya@gmail.com>
2022-01-14 08:58:02 +00:00
danieleades
99f905b8b4
Update sphinx/writers/texinfo.py
Co-authored-by: Takeshi KOMIYA <i.tkomiya@gmail.com>
2022-01-14 08:57:56 +00:00
Matthias Geier
a73df1e0f2 Skip "data:" URIs in ImageConverter 2022-01-13 20:15:31 +01:00
jfbu
63654129cb LaTeX: \pysig{start,stop}signatures and related \pysigline refactoring
This fixes #9924

Removes #9941 complex LaTeX macros, which incidentally had broken
effect of #9946 on issue #9926, as they become unneeded after the
refactoring of \pysigline/\pysiglinewithargs expansion context.
2022-01-13 19:26:23 +01:00
Takeshi KOMIYA
8ba20898b4 Update CHANGES for PR #9551 2022-01-14 02:56:47 +09:00
Takeshi KOMIYA
3b494b0ef8
Merge pull request #9551 from mgeier/remove-highlight-param
"Hide Search Matches" removes "highlight" parameter from URL
2022-01-14 02:55:57 +09:00
Takeshi KOMIYA
008005cc39 Fix #9981: std domain: Strip value part of the option directive from genindex 2022-01-14 02:25:00 +09:00
Takeshi KOMIYA
ce6803a186
Merge pull request #10095 from sphinx-doc/dependabot/npm_and_yarn/follow-redirects-1.14.7
Bump follow-redirects from 1.7.0 to 1.14.7
2022-01-13 18:45:34 +09:00
dependabot[bot]
811230d94b
Bump follow-redirects from 1.7.0 to 1.14.7
Bumps [follow-redirects](https://github.com/follow-redirects/follow-redirects) from 1.7.0 to 1.14.7.
- [Release notes](https://github.com/follow-redirects/follow-redirects/releases)
- [Commits](https://github.com/follow-redirects/follow-redirects/compare/v1.7.0...v1.14.7)

---
updated-dependencies:
- dependency-name: follow-redirects
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
2022-01-13 04:40:53 +00:00
Daniel Eades
6697ed62ed address some unused loop control variables (B007) 2022-01-12 20:19:18 +00:00
Takeshi KOMIYA
48dc4b8a96 test: Follow the new HTML structure of docutils-0.18
Since docutils-0.18, the HTML structure for citations and footnotes has
been changed.  This modifies our testcase to follow the new HTML structure.
2022-01-13 02:12:37 +09:00
Takeshi KOMIYA
49196d4474 Update CHANGES for PR #10091 2022-01-13 01:40:59 +09:00
Takeshi KOMIYA
14821a9777
Merge pull request #10091 from Jean-Abou-Samra/sorted-glossary
In translated docs, sort glossaries by translated terms
2022-01-13 01:39:14 +09:00
Jean Abou Samra
0269bec1ed In translated docs, sort glossaries by translated terms
This is done by moving the sorting from the glossary directive to a
transform operating after the i18n transform.

Closes #9827
2022-01-12 16:47:40 +01:00
Takeshi KOMIYA
c5a888ffdf
Merge pull request #10067 from tk0miya/10062_change_default_language_to_en
Close #10062: Change the default language to 'en'
2022-01-12 23:56:41 +09:00
Takeshi KOMIYA
e4e58a4f27 Close #10062: Change the default language to 'en'
Change the default language to `'en'` if any language is not set in
`conf.py`.
2022-01-12 02:45:52 +09:00
Takeshi KOMIYA
3ed92651d5
Merge pull request #10068 from tk0miya/10057_scanning_docs_on_root
Fix #10057: Failed to scan documents on the root directory
2022-01-12 02:42:08 +09:00
Takeshi KOMIYA
9a42e42a40
Merge pull request #10069 from tk0miya/10055_ensuredir_for_warnfile
Close #10055: sphinx-build: Create directories when `-w` option given
2022-01-12 02:35:15 +09:00
Takeshi KOMIYA
99c144d8cd
Merge pull request #10079 from tk0miya/10061_confval_added_by_themes_not_initialized
Fix #10061: html theme: Confvals added by themes are not initialized
2022-01-12 02:34:52 +09:00
Takeshi KOMIYA
2b784e23d8
Merge pull request #10080 from danieleades/refactor/simplify-set-comparison
simplify some set comparisons (SIM109)
2022-01-12 02:34:21 +09:00
Takeshi KOMIYA
726f2eaa97
Merge pull request #10085 from tk0miya/10058_autodoc_class_signature_misleads_autosummary
Fix #10058: autosummary: Imported members are not shown
2022-01-12 02:32:10 +09:00
marxin
5295c5d4e8 Latex: fix vertical spacing for cpp:function.
As described in the issue, there is a pair of
`\pysigstartmultiline/\pysigstopmultiline` for each `desc_signature`
element and thus there is extra spacing when multiple functions
are documented.

Fixes: #9924.
2022-01-11 15:25:13 +01:00
Daniel Eades
e51591d061 simplify some set comparisons (SIM109) 2022-01-10 19:56:30 +00:00
Takeshi KOMIYA
e79681c768
Merge pull request #10081 from danieleades/refactor/callable-test
use 'callable' to check if object is callable (B004)
2022-01-11 02:32:17 +09:00
Takeshi KOMIYA
b5f4d2d883
Merge pull request #10083 from danieleades/refactor/named-tuples
use class-style syntax for 'NamedTuple's
2022-01-11 02:29:03 +09:00
Philipp A
547f0a2d02 Fix typing in docfields.py 2022-01-11 02:28:27 +09:00
Takeshi KOMIYA
e1fa6c79be
Merge pull request #10084 from flying-sheep/patch-1
Fix typing in docfields.py
2022-01-11 02:27:46 +09:00
Takeshi KOMIYA
7f0166780f Fix #10058: autosummary: Imported members are not shown
Originally, the `check_module()` call was added at 21b8384 to hide
imported members on generating stubs.  But it was incorrect approach.
Therefore it was disabled by b433197 and fixed the original issue by
another approach at 2390c554.

Finally, the `check_module()` call becomes meaningless code.  But, at
present, it causes that imported members are not shown when
`autodoc_class_signature` is 'separated'.  To resolve the problem, this
removes the meaningless call.
2022-01-11 02:18:29 +09:00
Philipp A
81998842f5
Fix typing in docfields.py 2022-01-10 17:02:40 +01:00
Daniel Eades
574e787bf1 use class-style syntax for 'NamedTuple's 2022-01-10 15:35:27 +00:00
Daniel Eades
61ff90460d use 'callable' to check if object is callable (B004) 2022-01-10 13:51:35 +00:00