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
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
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
aa1bc83c2a
Merge branch '4.x'
2022-03-19 22:58:15 +09:00
Takeshi KOMIYA
7b55447b7e
Update versionadded to 4.5
2022-03-06 18:47:17 +09:00
Takeshi KOMIYA
fa63db8dc6
Update versionadded to 4.5
2022-03-06 18:47:11 +09:00
Takeshi KOMIYA
08f5d97a82
Fix #10223 : doc: Add descriptions of :module: option for python directives
2022-03-06 16:10:40 +09: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
1cb5a3b5fa
Merge commit '799385f5558a888d1a143bf703d06b66d6717fe4'
2022-02-16 00:25:53 +09:00
Jean Abou Samra
dfcb5d2f4c
Categorize warnings for inconsistent references in i18n
...
This allows suppressing them using the suppress_warnings configuration
variable.
2022-02-15 14:32:22 +01:00
Takeshi KOMIYA
8b23f6db12
Merge commit '07110b7557a552ecfe702bdd6a2d2f9685cb1af9'
2022-02-14 03:03:40 +09:00
Takeshi KOMIYA
d7c6fa853c
Merge commit '2be06309518d9401a42880bb5b4321dfdd1e5e90'
2022-02-14 03:02:31 +09:00
Takeshi KOMIYA
680417a10d
Merge pull request #10150 from tk0miya/10146_autodoc_default_options_should_support_no-value
...
Close #10146 : autodoc: autodoc_default_options does not support `no-value` option
2022-02-06 15:59:24 +09:00
Takeshi KOMIYA
7469096e0a
Update doc/usage/extensions/autodoc.rst
2022-02-06 15:30:54 +09:00
Noah Sprent
25c4287da5
Remove commas when describing characters for section headings
2022-02-02 10:52:06 +01:00
Takeshi KOMIYA
b0b51cecc2
Close #10146 : autodoc: autodoc_default_options does not support no-value option
2022-01-31 01:51:37 +09:00
Takeshi KOMIYA
799385f555
Merge pull request #9337 from marxin/new-shortcuts
...
Implement new search shortcuts.
2022-01-31 00:11:45 +09:00
Timo Cornelius Metzger
8f39f29725
Update autosummary.rst
2022-01-27 20:22:45 -08:00
Martin Liska
8cf3179ad2
Implement new shortcuts:
...
- "/" for Focus search bar
- "ESC" - clear highlighted text
Fixes #691 .
Co-authored-by: Jakob Lykke Andersen <jakobandersen@users.noreply.github.com>
2022-01-22 16:16:35 +01:00
Takeshi KOMIYA
72bb5c998f
Close #9456 : html search: Add a config variable; html_show_search_summary
...
refs: #9494
2022-01-17 01:44:42 +09: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
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
fe338f603b
Merge branch 'master' into 9595_deprecate_setuptools_integration
2022-01-02 18:18:01 +09: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
0663602bb9
Close #9595 : Deprecate setuptools integration
2022-01-01 20:19:27 +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
5dc27f5948
Merge branch '4.x'
2021-12-17 02:09:33 +09:00
Takeshi KOMIYA
dd27e35e4c
doc: Use "console" for the highlight language of console output
...
Using "console" language is better for the console example (including
command-line prompt)
2021-12-13 14:20:37 +09:00
Takeshi KOMIYA
0e51ddef34
Merge branch '4.x'
2021-12-11 23:18:46 +09:00
Takeshi KOMIYA
d3162d1ff2
Merge pull request #9931 from tk0miya/9075_autodoc_unqualified_typehints
...
Close #9075 : autodoc: Add a config variable autodoc_unqualified_typehints
2021-12-11 10:59:23 +09:00
Takeshi KOMIYA
8d071a8e8f
Merge branch '4.x' into texinfo-add-texinfo_emit_document_references
2021-12-11 10:27:50 +09:00
Takeshi KOMIYA
980ccc4c2a
Merge branch '4.x'
2021-12-10 01:45:15 +09:00
Christian Roth
10023da895
linkcheck: Exclude links from matched documents
2021-12-08 10:01:45 +01:00
Agbonze Osazuwa
6f4280c0a3
Fixes statement typo
2021-12-04 13:13:17 +01: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
