Commit Graph

1019 Commits

Author SHA1 Message Date
Takeshi KOMIYA
21e3a96f09 Close #8417: autodoc: :inherited-members: option now takes multiple classes
It allows to suppress inherited members of several classes on the module at
once by specifying the option to `automodule` directive
2022-04-03 20:17:41 +09:00
Takeshi KOMIYA
0d31fc9614 Merge branch '5.x' into 10266_autodoc_preserve_defaults_crashes_on_kwonlyargs_without_defaults 2022-04-03 16:57:32 +09:00
Takeshi KOMIYA
a78c07ca07 Fix #10280: autodoc_docstring_signature generates needless return typehint
Basically, autodoc suppresses return value typehint for class
constructors.  But it was unexpectedly shown if
`autodoc_docstring_signature` is enabled and docstring has multiple
signatures.
2022-04-03 16:32:35 +09:00
Takeshi KOMIYA
f5e4e70817 Fix #10266: autodoc_preserve_defaults crashes on kwonlyargs w/o defaults 2022-04-02 16:55:48 +09:00
Takeshi KOMIYA
223b1a94f2 Merge branch '4.x' 2022-03-28 01:00:37 +09:00
Takeshi KOMIYA
b20e04968e Merge pull request #10107 from Jean-Abou-Samra/intl-warnings
Implement #noqa for i18n
2022-03-27 23:00:57 +09:00
Takeshi KOMIYA
2db180da70 Merge branch '4.x' 2022-03-27 19:47:11 +09:00
Takeshi KOMIYA
c6230dc4db extlinks: Disable hardcoded links detector by default (refs: #10126)
The hardcoded links detector added since 4.4.0 causes troubles in many
projects.  Therefore, this disables it by default, and adds a new
configuration `extlinks_detect_hardcoded_links` to enable it explicitly.
2022-03-27 15:22:11 +09:00
Takeshi KOMIYA
aa1bc83c2a Merge branch '4.x' 2022-03-19 22:58:15 +09:00
Adam Turner
4f5a3269a6 Fix module docstring first line 2022-02-20 00:11:08 +00:00
Takeshi KOMIYA
f72cd83e4d Merge branch '4.x' 2022-02-19 16:08:05 +09:00
Jean Abou Samra
94d78d8747 Close #3985: Implement #noqa for i18n
When cross-references in the original paragraph and the translated
paragraph do not match, a warning is emitted.  It is useful, because
it allows to catch mistakes, but it can also be an annoyance since
sometimes it is expected that the cross-references will not match.
For example, a reference that is repeated in the original text may
need to be factored out for good style in the target language.
Another example: if the translator needs to translate a universally
understood term in the source language into a term that not everyone
knows is the translation of this original term, adding a reference to
the glossary can be warranted.  This allows the translated message to
start with '#noqa' in order to disable the warning.
2022-02-15 19:51:06 +01:00
Takeshi KOMIYA
1546b21f89 Fix #9529: LaTeX: named footnotes are converted to "?"
Named auto numbered footnote (ex. ``[#named]``) that is referred
multiple times was rendered to a question mark.

This calls `\sphinxstepexplicit` for every footnote node that is
referred multiple times.
2022-02-06 15:59:01 +09:00
Takeshi KOMIYA
9b142f15e6 test: Add testcase for named footnotes 2022-02-06 14:33:29 +09:00
Takeshi KOMIYA
444dfc50aa Merge branch '4.x' 2022-01-17 00:22:09 +09:00
Jakob Lykke Andersen
c11b109d59 intersphinx role: :external+inv:**: instead of :external:inv+**: 2022-01-16 09:48:11 +01:00
Jakob Lykke Andersen
029d0e5b18 intersphinx role: new inventory parsing from role name 2022-01-16 09:48:06 +01:00
Jakob Lykke Andersen
ce5512e3af intersphinx role, implement warning scheme
and temporarily remove explicit inventories
2022-01-16 09:48:06 +01:00
Jakob Lykke Andersen
184fd6a4aa intersphinx role, update based on merged refactoring 2022-01-16 09:48:06 +01:00
Jakob Lykke Andersen
36c6eafdf1 intersphinx: explicitly parse out inventory specification 2022-01-16 09:48:06 +01:00
Jakob Lykke Andersen
69fa5260fc intersphinx role: rename to 'external' 2022-01-16 09:47:54 +01:00
Jakob Lykke Andersen
8605644e83 intersphinx: more role testing 2022-01-16 09:47:54 +01:00
Takeshi KOMIYA
35dcc60a7c intersphinx: Add :intersphinx:***: role 2022-01-16 09:47:53 +01:00
Takeshi KOMIYA
6a0215198f Merge branch '4.x' 2022-01-16 02:26:11 +09:00
Takeshi KOMIYA
6611140c76 Merge branch '4.x' into HEAD 2022-01-15 19:46:45 +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
6f707a0944 Merge branch '4.x' 2022-01-02 17:24:12 +09:00
Takeshi KOMIYA
e434dd6998 Merge pull request #10042 from tk0miya/9820_distutils
refactor: Reduce usages of distutils (refs: #9820)
2022-01-02 12:08:49 +09:00
Takeshi KOMIYA
e1c090d9f7 Merge pull request #10034 from tk0miya/10027_autodoc_typehints_format_for_bases
Fix #10027: autodoc_typehints_format does not work with :show-inheritance:
2022-01-02 11:39:22 +09:00
Takeshi KOMIYA
0ba202009d refactor: Reduce usages of distutils (refs: #9820)
distutils module is now deprecated and will be removed since Python
3.12.  So this reduces the usages of the module.
2022-01-01 21:38:56 +09:00
Takeshi KOMIYA
ce8039db1f Merge branch '4.x' 2022-01-01 20:04:19 +09:00
Takeshi KOMIYA
b84771dcd2 A happy new year! 2022-01-01 18:45:03 +09:00
Takeshi KOMIYA
3fc98a2b3d Fix #10027: autodoc_typehints_format does not work with :show-inheritance: 2022-01-01 18:06:57 +09:00
jfbu
4235195e77 Fix a spelling typo in tests (s/änhlich/ähnlich) 2021-12-22 12:44:28 +01:00
Christian Roth
10023da895 linkcheck: Exclude links from matched documents 2021-12-08 10:01:45 +01:00
Takeshi KOMIYA
e8e45a3678 Merge pull request #9905 from tk0miya/9883_ismock
Fix #9883: autodoc: doccomment for the alias to mocked object was ignored
2021-11-30 01:37:41 +09:00
Takeshi KOMIYA
74d912133a Merge pull request #9800 from hoefling/extlinks/replacements-check
Proposal: check if hardcoded URLs can be replaced with extlinks
2021-11-29 09:36:55 +09:00
Takeshi KOMIYA
f88ac53e51 Fix #9883: autodoc: doccomment for the alias to mocked object was ignored 2021-11-29 02:06:16 +09:00
Takeshi KOMIYA
15d834e4d8 Merge pull request #9831 from Yoshanuikabundi/autosummary___all__
Allow autosummary to respect __all__
2021-11-26 02:15:43 +09:00
Takeshi KOMIYA
fb92547b91 Fix #9866: autodoc: doccoment for the imported class was ignored
Autodoc tried to scan doccomment on the module where the class defined.
But it failed to get it if the class is imported from other module.

This analyzes the target module to obtain the doccomment.
2021-11-21 18:50:54 +09:00
Josh Mitchell
ad0071ddb7 #2021: Allow autosummary to respect __all__ 2021-11-15 13:16:33 +11:00
oleg.hoefling
8356260554 extlinks: replacement suggestions for hardcoded links
Signed-off-by: oleg.hoefling <oleg.hoefling@gmail.com>
2021-11-12 09:38:59 +01:00
Takeshi KOMIYA
b8844eb339 Fix #9781: autodoc_preserve_defaults does not support hexadecimal 2021-10-31 01:11:56 +09:00
Takeshi KOMIYA
b778ee806e Fix #9752: autodoc: Failed to detect type annotation for slots attribute 2021-10-23 14:59:36 +09:00
Takeshi KOMIYA
d288907fd1 Merge branch '4.x' into 9607_incorrect_orig_bases 2021-09-27 02:21:14 +09:00
Takeshi KOMIYA
d75e3171cd Merge pull request #9670 from jonppe/fix-download-file-with-special-characters
Fix download file with special characters
2021-09-25 14:38:48 +09:00
Johannes Aalto
fa3b334ed0 Add test for encoding local file links with special characters
Add test to make sure Sphinx uses proper URL encoding for
special characters in file names.

Use test_html_download() since it test_html5_output() doesn't
quite seem to have easy pattern to verify the contents of href
attribute.

Issue #3097

Signed-off-by: Johannes Aalto <ext-johannes.aalto@vaisala.com>
2021-09-24 20:34:09 +03:00
Latosha Maltba
cf9b5b5be9 Add tests for :dedent: option of code-block directive 2021-09-21 09:19:53 +00:00
Takeshi KOMIYA
10b7f0e252 Fix #9607: autodoc: Incorrect base class detection
In case of the descendants of generic class, the value of
obj.__orig_bases__ is incorrect because it returns original base
arguments for the child of the generic class instead of the target
class itself.

This uses obj.__dict__ to get the correct __orig_bases__ information.
2021-09-20 13:20:26 +09:00
Takeshi KOMIYA
ccfca458ea Close #9639: autodoc: Support asynchronous generator functions 2021-09-17 02:20:40 +09:00