Commit Graph

17445 Commits

Author SHA1 Message Date
Takeshi KOMIYA
f37e679fd1 doc: Update document for autodoc :members: option 2021-03-06 19:12:34 +09:00
Takeshi KOMIYA
1ea11b1e48 Fix #759: autodoc: Add sphinx.ext.autodoc.preserve_defaults extension
Add a new extension `sphinx.ext.autodoc.preserve_defaults`.

It preserves the default argument values of function signatures in source code
and keep them not evaluated for readability.  This is an experimental
extension and it will be integrated into autodoc core in Sphinx-4.0.
2021-03-06 18:48:18 +09:00
Takeshi KOMIYA
647510e184 Merge branch '3.x' 2021-03-06 18:43:15 +09:00
Takeshi KOMIYA
c2fac1eed0 Merge branch '3.5.x' into 3.x 2021-03-06 18:43:05 +09:00
Takeshi KOMIYA
3cd103095f
Merge branch '3.5.x' into 8943_update_translations 2021-03-06 17:48:11 +09:00
Takeshi KOMIYA
cb14587af5
Merge pull request #8958 from tk0miya/8936_custom_latex_builder
Fix #8936: LaTeX: A custom LaTeX builder fails with unknown node error
2021-03-06 17:47:25 +09:00
Takeshi KOMIYA
0a3f897d15
Merge pull request #8432 from tk0miya/7119_pending_xref_condition
Fix #7119: Show type hint names unqualified when resolving succeeded
2021-03-06 17:32:27 +09:00
Takeshi KOMIYA
866e244770
Merge branch '3.5.x' into 8936_custom_latex_builder 2021-03-06 17:31:06 +09:00
Takeshi KOMIYA
ad10c62d74
Merge pull request #8957 from tk0miya/8952_hangup_on_parallel_build
Fix #8952: Exceptions raised in a Directive cause parallel builds to hang
2021-03-06 17:30:00 +09:00
Takeshi KOMIYA
7f0b13af6e intersphinx: Support pending_xref_condition 2021-03-06 14:58:15 +09:00
Takeshi KOMIYA
930a880294 Fix #7199: py domain: Add a new confval: python_use_unqualified_type_names
Add a new config variable: python_use_unqualified_type_names.  If enabled,
it goes to suppress the module name of the python reference if it can be
resolved.
2021-03-06 14:00:00 +09:00
Jakob Lykke Andersen
6886de29f2
Merge pull request #8961 from jakobandersen/c_cpp_nested_params
C and C++, fix nested params
2021-03-05 20:06:51 +01:00
Takeshi KOMIYA
d99132680d Filter pending_xref_condition node on failed resolution 2021-03-06 02:01:05 +09:00
Takeshi KOMIYA
e1130972b2 Add pending_xref_condition node
To choose appropriate content for pending_xref node on resolving,
this introduces a new custom node `pending_xref_condition`.  It only
has a condition for the filtering and contents of the reference.
2021-03-06 02:01:03 +09:00
Takeshi KOMIYA
851442977e
Merge pull request #8962 from igo95862/3.x
Fix py.typed file not being included in source archive
2021-03-05 21:44:14 +09:00
igo95862
ff78849557
Fix py.typed file not being included in source archive 2021-03-05 14:19:22 +03:00
Jakob Lykke Andersen
72e231d0e6 C and C++, fix nested paramter lists 2021-03-04 21:28:18 +01:00
Takeshi KOMIYA
f75e86d53a Fix #8936: LaTeX: A custom LaTeX builder fails with unknown node error
At present, post transform components for LaTeX builder does not work
for the custom LaTeX builder that inherits the original LaTeX builder.
This allows them working with the custom LaTeX builders.
2021-03-05 00:36:38 +09:00
Takeshi KOMIYA
ff49bfa003
Merge pull request #8947 from tk0miya/deprecate_registry.get_source_input
Deprecate SphinxComponentRegistry.get_source_input()
2021-03-05 00:06:05 +09:00
Takeshi KOMIYA
ec6ab7243d Fix #8952: Exceptions raised in a Directive cause parallel builds to hang
Do shutdown explicitly when failure on the subprocess.
2021-03-04 23:29:52 +09:00
Takeshi KOMIYA
bae8fb6909 i18n: Fix wrong substitution message catalog for el and hr (refs: #8943) 2021-03-04 22:11:28 +09:00
Takeshi KOMIYA
247777104a
Merge pull request #8954 from askhl/safer-translatable-strings
Safe formatting of translatable strings
2021-03-04 22:05:31 +09:00
Takeshi KOMIYA
e13756a6b7 Merge branch '3.x' 2021-03-04 22:05:06 +09:00
Takeshi KOMIYA
06b4751f3e Merge branch '3.5.x' into 3.x 2021-03-04 22:04:55 +09:00
Takeshi KOMIYA
58c0855a29
Merge pull request #8955 from larsoner/fix-rebuild
BUG: Fix rebuild regression
2021-03-04 21:51:28 +09:00
Eric Larson
17599133f7 BUG: Fix rebuild regression 2021-03-03 16:28:33 -05:00
Ask Hjorth Larsen
cf85d3afd1 format translatable strings in one go. This enables translation tools like msgfmt to verify that an incorrect translation cannot crash sphinx-build. This will fix current crashes for Hungarian and Greek (Spanish was fixed in #8941) 2021-03-03 19:52:49 +01:00
Jakob Lykke Andersen
cba9ed0bb5
Merge pull request #8951 from jakobandersen/cpp_spaceship
C++, support spaceship operator
2021-03-02 20:47:04 +01:00
Jakob Lykke Andersen
4052cbc9b1 C++, support spaceship operator
Fixes sphinx-doc/sphinx#8942
2021-03-02 20:22:22 +01:00
Takeshi KOMIYA
b923165d5e Update CHANGES for PR #8937 2021-03-02 22:27:46 +09:00
Takeshi KOMIYA
a638a8d582
Merge pull request #8937 from jantonguirao/fix_explicit_title_subpages
Use explicit title instead of <no title> in the title bar of subpages
2021-03-02 22:26:11 +09:00
Takeshi KOMIYA
99d97c65d5
Merge pull request #8943 from askhl/3.5.x-fix-spanish-template
Spanish translation: fix bad substitution templates
2021-03-02 22:19:20 +09:00
Takeshi KOMIYA
61c9c7fc58 Deprecate SphinxComponentRegistry.get_source_input()
The source_input system was deprecated at v2.0.  So no client uses it
longer now.  Therefore this deprecate the getter interface and its
usage.
2021-03-02 21:18:31 +09:00
Ask Hjorth Larsen
001c6f8a1c update .mo file as well 2021-03-01 18:38:06 +01:00
Ask Hjorth Larsen
8144c52228 Spanish translation: fix bad substitution templates 2021-03-01 17:57:52 +01:00
Joaquin Anton
2c6c1469ee Apply code review suggestions
Signed-off-by: Joaquin Anton <janton@nvidia.com>
2021-03-01 10:32:31 +01:00
Takeshi KOMIYA
727e95f15c Update CHANGES for PR #8905 2021-02-28 23:45:23 +09:00
Takeshi KOMIYA
102393fbc2
Merge pull request #8905 from graingert/patch-1
migrate html_add_permalinks=None and html_add_permalinks=""
2021-02-28 23:37:58 +09:00
Thomas Grainger
878c116112
Update sphinx/builders/html/__init__.py 2021-02-28 14:29:07 +00:00
Thomas Grainger
ae5986f9cd
Update sphinx/builders/html/__init__.py 2021-02-28 12:00:18 +00:00
Thomas Grainger
4f01fe08fa
Merge branch 'master' into patch-1 2021-02-28 11:59:47 +00:00
Takeshi KOMIYA
fc8247a3cd
Merge pull request #8484 from tk0miya/8326_root_doc
Close #8326: Rename master_doc to root_doc
2021-02-28 17:49:32 +09:00
Takeshi KOMIYA
3059a999b2 Close #8326: Rename master_doc to root_doc
To describe the purpose more accurately, the `master_doc` is now renamed
to `root_doc`.  The old name is still available.  But it is recommeneded
to use new one from now on.
2021-02-28 17:10:57 +09:00
Takeshi KOMIYA
836cd05236
Merge pull request #8426 from tk0miya/8415_unresolved_imported_TypeVar
autodoc: an imported TypeVar is not resolved (refs: #8415)
2021-02-28 16:45:55 +09:00
Takeshi KOMIYA
7d3cc382fa autodoc: an imported TypeVar is not resolved (refs: #8415)
So far, a TypeVar is rendered without module name. As a result, it
could not be resolved if it is imported from other modules.  This
prepends its module name and make it resolvable.  This is available
only in Python 3.7 or above.

As a side effect, all of TypeVars are displayed with module name. It
should be fixed in latter step (refs: #7119)
2021-02-28 15:58:06 +09:00
Takeshi KOMIYA
6ca7c1c579
Merge pull request #8939 from tk0miya/8938_imgconverter_show_OSError
Fix #8938: imgconverter: Show the error of the command availability check
2021-02-28 12:57:32 +09:00
Takeshi KOMIYA
2c987897eb
Merge pull request #8935 from tk0miya/8933_viewcode_backlink_on_parallel_build
Fix #8933: viewcode: Failed to create back-links on parallel build
2021-02-28 12:56:58 +09:00
Takeshi KOMIYA
347ae4ff47 Fix #8938: imgconverter: Show the error of the command availability check
imgconverter extension suppresses an OSError like "Cannot allocate
memory" unexpectedly.  So the error should be shown with the warning.
2021-02-27 13:01:34 +09:00
Joaquin Anton
3f62d2f294 Use explicit title for titlenode, when no title is provided
Signed-off-by: Joaquin Anton <janton@nvidia.com>
2021-02-26 14:26:09 +01:00
Takeshi KOMIYA
4f7f3304b1
Merge pull request #8875 from tk0miya/refactor_latex_writer3
refactor: LaTeX: Use raw strings for LaTeX macros
2021-02-26 02:25:14 +09:00