Commit Graph

4030 Commits

Author SHA1 Message Date
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
Daniel Eades
61ff90460d use 'callable' to check if object is callable (B004) 2022-01-10 13:51:35 +00:00
Takeshi KOMIYA
6402acde81 Merge pull request #10051 from tk0miya/9777_quotes_in_manpage
test: manpage: double quotes are escaped since docutils-0.18
2022-01-03 12:16:28 +09:00
Takeshi KOMIYA
d1a070efd8 test: manpage: double quotes are escaped since docutils-0.18
Double quotes are escaped to `\(dq` on manpage output since
docutils-0.18.
2022-01-03 02:01:46 +09:00
Takeshi KOMIYA
a0e44a7300 test: Migrate to Node.findall() from Node.traverse() 2022-01-03 01:06:20 +09:00
Takeshi KOMIYA
05a898ecb4 Migrate to Node.findall() from Node.traverse()
Node.traverse() was marked as deprecated since docutils-0.18.  Instead
of it, Node.findall() has been added as successor of traverse().

This applies a patch to docutils-0.17 or older to be available
Node.findall() and use it.
2022-01-03 00:35:29 +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
f38bd8e952 Merge branch '4.3.x' into 4.x 2022-01-01 20:02:10 +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
Takeshi KOMIYA
6df45e0ead Add mode parameter to sphinx.util.typing:restify()
To make the typehints in "Bases" field simple, this adds a new parameter
`mode` to sphinx.util.typing:restify() to suppress the leading module
name from typehints in "Bases" field.
2022-01-01 14:24:43 +09:00
Takeshi KOMIYA
eed0730b4b Merge pull request #10021 from tk0miya/10015_typehints_format_with_typehints_in_description
Fix #10015: autodoc: autodoc_typehints_format='short' does not work when autodoc_typehints='description'
2021-12-29 02:09:35 +09:00
Takeshi KOMIYA
a284aa6571 Merge pull request #10018 from tk0miya/10013_add_async_js_file
Close #10013: html: Allow to change the loading method of JavaScript
2021-12-27 02:30:00 +09:00
Takeshi KOMIYA
1f71f85fd6 Fix #10015: autodoc: autodoc_typehints_format='short' does not work when autodoc_typehints='description' 2021-12-27 02:23:02 +09:00
Takeshi KOMIYA
5da68c3de3 Fix py domain: "typing" types are not hyperlinked in info-field-list 2021-12-27 02:23:02 +09:00
Takeshi KOMIYA
f3a098d4e9 Merge branch '4.x' into 9194_Literal_type_not_hyperlinked 2021-12-26 20:34:38 +09:00
Takeshi KOMIYA
7da429924e Fix testcase in py36 case 2021-12-26 20:34:05 +09:00
Takeshi KOMIYA
2ea9118181 refactor: Merge arguments of sphinx.util.typing:stringify() 2021-12-26 03:11:39 +09:00
Takeshi KOMIYA
bdbad40f57 Fix #9194: autodoc: Prepend the "typing" module name on the signature
To create hyperlinks to container types automatically, this prepends the
module names for the types under "typing" module.
2021-12-26 01:04:40 +09:00
Takeshi KOMIYA
b5bf745f68 Close #10013: html: Allow to change the loading method of JavaScript 2021-12-25 23:41:02 +09:00
Takeshi KOMIYA
0a5783f75b py domain: Suppress the leading "typing." module from typehints
To support creating hyperlinks to container types naturally, py domain
should take fully-qualified typehints for them.  But nobody wants to
show "typing." module name on the signature. So this suppresses them
automatically.
2021-12-25 02:50:31 +09:00
Takeshi KOMIYA
94cbce69da Fix #9194: autodoc: types in typing module are not hyperlinked
This converts types in typing module to valid references when
`autodoc_unqualified_typehints` option enabled.
2021-12-25 02:50:31 +09:00
Takeshi KOMIYA
49f576569c Fix autodoc: Failed to parse Literal type in py36 and py37 2021-12-25 02:41:38 +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
e3ee8b378a Close #9993: std domain: Allow to refer an inline target via ref role 2021-12-21 02:51:59 +09:00
Takeshi KOMIYA
40db5694fa Merge pull request #9992 from tk0miya/debug_print
test: Remove debug print
2021-12-19 18:31:52 +09:00
Takeshi KOMIYA
627d73a683 test: Remove debug print 2021-12-19 18:15:56 +09:00
Takeshi KOMIYA
cacbca6dd4 Merge pull request #9987 from tk0miya/9968_ivar_not_shown
Fix #9968: autodoc: ivars are not shown if __init__ has posonlyargs
2021-12-19 13:18:58 +09:00
Takeshi KOMIYA
e7e08d2a78 Fix #9968: autodoc: ivars are not shown if __init__ has posonlyargs 2021-12-19 12:53:15 +09:00
Takeshi KOMIYA
a9a9bd2563 Fix #9979: Error level messages were displayed as warning messages 2021-12-17 02:10:21 +09:00
Takeshi KOMIYA
8d0fd9e74a Merge branch '4.3.x' into 4.x 2021-12-17 02:09:04 +09:00
Takeshi KOMIYA
3626c75de0 Merge pull request #9957 from tk0miya/refactor_DeprecationWarnings
Reduce DeprecationWarnings
2021-12-16 01:38:32 +09:00
Takeshi KOMIYA
8e23b03263 refactor: texinfo: Remove CR char from output
The CR character was added for readability of output.  But it makes the
texinfo writer a bit complicated.  This removes it from output to keep
our code simple (reducing conditions).
2021-12-11 23:05:36 +09:00
Takeshi KOMIYA
5563f672ec Merge branch '4.x' into fix-footnote-in-info 2021-12-11 22:59:56 +09:00
Takeshi KOMIYA
dcfc3f60ec refactor: ssl.wrap_context() has been deprecated now 2021-12-11 11:38:24 +09:00
Takeshi KOMIYA
555e74b8ca refactor: app.html_themes was replaced by registry.html_themes 2021-12-11 11:38:24 +09:00
Takeshi KOMIYA
4c7df3f09a Merge pull request #9793 from samdoran/enable-parallel-on-macos
Set multiprocessing start method to `fork`
2021-12-11 11:23:34 +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
9c6ebdf347 Fix flake8 warnings 2021-12-11 10:33:07 +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
b232b00cf8 Merge pull request #9391 from marxin/info-samp-with-variable
texinfo: improve variable in :samp: directives
2021-12-11 10:25:07 +09:00
Christian Roth
10023da895 linkcheck: Exclude links from matched documents 2021-12-08 10:01:45 +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
Takeshi KOMIYA
5aa6cbbca8 Add unqualified_typehints parameter to stringify_signature()
To make the generated function signatures simple, this adds a new
parameter `unqualified_typehints` to sphinx.util.inspect:
stringify_signature() to suppress the leading module name of
typehints.
2021-12-03 18:05:49 +09:00
Takeshi KOMIYA
80f79aef91 Add smartref parameter to sphinx.util.typing:stringify()
To make the generated function signatures simple, this adds a new
parameter `smartref` to sphinx.util.typing:stringify() to suppress the
leading module name from typehints.
2021-12-03 18:05:49 +09:00
Jakob Lykke Andersen
f8f26286ad C, simple type specifier parsing, handling macro-keywords 2021-12-01 19:33:23 +01:00
Jakob Lykke Andersen
c09643c21f C, fix parsing of fundamental types
When multiple simple type specifiers are part of the type,
then they may appear in any order.
2021-11-30 22:00:54 +01:00
Jakob Lykke Andersen
67d673406f C++, fix parsing of fundamental types
When multiple simple type specifiers are part of the type,
then they may appear in any order.
2021-11-30 22:00:20 +01:00