Stefaan Lippens
b98b1b3419
sphinx.ext.napoleon docs: fix Google style link
2022-04-25 12:35:40 +02:00
Takeshi KOMIYA
da73960492
Merge branch '5.x' into autodoc_force_undocumented_rtype
2022-04-03 22:45:42 +09:00
Takeshi KOMIYA
fd42063725
autodoc_typehints_description_target: Rename returnvalue_and_documented_params to documented_params
2022-04-03 22:42:44 +09:00
Takeshi KOMIYA
f731bf1999
Merge branch '5.x' into autodoc_force_undocumented_rtype
2022-04-03 22:29:22 +09:00
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
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
fbdfade068
doc: Use :pep: role to refer PEP documents
2022-03-27 01:46:22 +09:00
Hugo van Kemenade
a432bf8c10
Update PEP links in docs
2022-03-24 12:34:05 +02:00
Takeshi KOMIYA
f72cd83e4d
Merge branch '4.x'
2022-02-19 16:08:05 +09:00
Takeshi KOMIYA
8b23f6db12
Merge commit '07110b7557a552ecfe702bdd6a2d2f9685cb1af9'
2022-02-14 03:03:40 +09:00
Takeshi KOMIYA
7469096e0a
Update doc/usage/extensions/autodoc.rst
2022-02-06 15:30:54 +09:00
Takeshi KOMIYA
b0b51cecc2
Close #10146 : autodoc: autodoc_default_options does not support no-value option
2022-01-31 01:51:37 +09:00
Timo Cornelius Metzger
8f39f29725
Update autosummary.rst
2022-01-27 20:22:45 -08:00
Takeshi KOMIYA
444dfc50aa
Merge branch '4.x'
2022-01-17 00:22:09 +09:00
Jakob Lykke Andersen
3bf8bcd6e1
intersphinx role, update docs
2022-01-16 09:48:20 +01:00
Jakob Lykke Andersen
540d76035c
intersphinx role, documentation
2022-01-16 09:48:06 +01:00
Takeshi KOMIYA
616f112e6a
autodoc: The default of autodoc_typehints_format becomes to 'smart'
...
The default value of autodoc_typehints_format configuration is changed
to `'smart'`. It will suppress the leading module names of typehints
(ex. `io.StringIO` -> `StringIO`).
refs: #9075
2022-01-02 17:35:19 +09:00
Takeshi KOMIYA
6ee3dd1968
Merge branch '4.x'
2022-01-01 19:02:09 +09:00
Takeshi KOMIYA
a87153c018
autodoc: Rename autodoc_unqualified_typehints to autodoc_typehints_format (refs: #9931 )
2021-12-24 10:14:19 +09:00
Takeshi KOMIYA
4e8bca2f2f
Merge branch '4.x'
2021-12-24 00:30:29 +09:00
Takeshi KOMIYA
733ac6ed5f
doc: Update explanation of autodoc_unqualified_typehints (ref: #9931 )
2021-12-18 15:26:42 +09:00
Takeshi KOMIYA
0e51ddef34
Merge branch '4.x'
2021-12-11 23:18:46 +09:00
Takeshi KOMIYA
c71ff1cd21
Close #9075 : autodoc: Add a config variable autodoc_unqualified_typehints
...
If autodoc_unqualified_typehints feature enabled, autodoc suppresses the
leading module names of typehints of function signatures (ex.
`io.StringIO` -> `StringIO`)
2021-12-03 18:05:49 +09:00
gschwaer
33bebf5e87
docs: add new option to documentation
2021-11-29 20:08:23 +01:00
Takeshi KOMIYA
c45bf2ea32
Merge branch '4.x'
2021-11-28 01:09:10 +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
fae10db6ca
Merge branch '4.x'
2021-11-23 18:17:32 +09:00
Takeshi KOMIYA
e2c6146b3e
Fix #9864 : mathjax: Failed to render equations via MathJax v2
...
MathJax library has been loaded via "defer" method since v4.3.0. But
it prevents to work MathJax v2. This rollbacks the change and use
"async" method as default again.
To support changing the loading method, this allows to specify it via
mathjax_options.
2021-11-21 18:27:35 +09:00
Josh Mitchell
79089b5fa4
Corrections from review by tk0miya
2021-11-15 13:18:47 +11:00
Josh Mitchell
ad0071ddb7
#2021 : Allow autosummary to respect __all__
2021-11-15 13:16:33 +11:00
Jakob Lykke Andersen
68abc2a122
Change default value of intersphinx_disabled_reftypes
...
See discussion in sphinx-doc/sphinx#9459
2021-10-31 15:01:08 +01:00
Jakob Lykke Andersen
4c19d9f65a
Merge branch '4.x'
2021-10-31 14:44:45 +01:00
Jakob Lykke Andersen
56002be5e1
rename intersphinx_disabled_{refs -> reftypes}
...
And change format for domains to {name}:*
2021-10-31 13:56:26 +01:00
Jakob Lykke Andersen
484d74ad97
intersphinx_disabled_refs, doc default value
2021-10-31 13:42:26 +01:00
Jakob Lykke Andersen
cfbac2ceaa
intersphinx_disabled_refs, rename 'all' to '*'
2021-10-31 13:23:23 +01:00
Jakob Lykke Andersen
0d9f4cd469
Generalize to disable specific refs as well.
2021-10-31 13:15:47 +01:00
Jakob Lykke Andersen
c88c718397
Fix typo
2021-10-31 13:15:47 +01:00
Jakob Lykke Andersen
f22faa7e06
Add intersphinx_disabled_domains
...
Fixes sphinx-doc/sphinx#2068
Replaces sphinx-doc/sphinx#8981
2021-10-31 13:15:47 +01:00
Takeshi KOMIYA
080bb71afa
Merge branch '4.x'
2021-10-23 01:25:00 +09:00
Gabe R
1bc98b7860
Add missing space in intersphinx doc
...
There was a space missing between `-m` and `sphinx.ext.intersphinx` in the example of showing all mappings in a intersphinx file. I added it in.
2021-10-19 11:33:23 -07:00
Takeshi KOMIYA
3f51f1a6cf
Merge branch '4.x'
2021-10-09 13:50:50 +09:00
Takeshi KOMIYA
481c5e9c4b
Merge pull request #9534 from astrojuanlu/new-tutorial-describing-code
...
New Sphinx tutorial, part III
2021-10-09 13:05:48 +09:00
Takeshi KOMIYA
d13b86e02f
Close #9664 : autodoc: autodoc-process-bases supports reST snippet
...
This allows to inject a reST snippet through autodoc-process-bases
event. It helps to modify the base classes of any class to the expected
mark-up'ed text by custom extension.
2021-09-23 10:59:01 +09:00
Takeshi KOMIYA
3d8fbd992c
Merge branch '4.x'
2021-09-12 16:56:34 +09:00
Takeshi KOMIYA
8416813168
Merge pull request #9616 from jdufresne/fix-url
...
Update Sphinx url: s|https?://sphinx-doc\.org/|https://www.sphinx-doc.org/ |g
2021-09-11 17:16:47 +09:00
Takeshi KOMIYA
2c21e91b5f
Merge branch '4.x'
2021-09-11 17:13:21 +09:00
Christian Clauss
86583c578c
Fix typos discovered by codespell
2021-09-08 02:15:25 +02:00
Jon Dufresne
7dd112b110
Update Sphinx url: s|https?://sphinx-doc\.org/| https://www.sphinx-doc.org/ |g
...
https://sphinx-doc.org is unreachable, but is linked from the PyPI page:
https://pypi.org/project/Sphinx/ . Switch to https://www.sphinx-doc.org/
instead.
2021-09-06 13:15:48 -07:00
Nicolas Delon
bf588c42b2
Fix typo in autodoc documentation
2021-08-25 23:42:27 +02:00
