IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity
18,709 Commits 2 Branches 219 Tags 163 MiB
b0b51cecc2
Commit Graph

4055 Commits

Author SHA1 Message Date
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
c75e43a321
Merge pull request #10136 from tk0miya/10133_autodoc_mocked_module 
Fix #10133: autodoc: Crashed when mocked module is used for type annotation
 2022-01-30 23:35:54 +09:00
Takeshi KOMIYA
444e27865d Fix #10133: autodoc: Crashed when mocked module is used for type annotation 2022-01-30 23:19:55 +09:00
Takeshi KOMIYA
d8a398bbdd Close #10125: extlinks: Improve suggestion message for a reference having title 2022-01-23 20:09:47 +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
ccc4f95b42 intersphinx role, hax role name to preserve case 2022-01-16 09:48:06 +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
d82d370739
Merge pull request #10078 from danieleades/refactor/unused-loop-control-variables 
address some unused loop control variables
 2022-01-16 02:46:32 +09:00
Takeshi KOMIYA
3b8387f469
Merge pull request #10097 from tk0miya/10029_strip_value_from_cmdoption 
Fix #9981: std domain: Strip value part of the option directive from genindex
 2022-01-16 02:44:24 +09:00
Takeshi KOMIYA
542db8ffb6
Merge pull request #10101 from Gobot1234/4.x 
Fix empty returns section
 2022-01-16 02:40:58 +09:00
James Hilton-Balfe
ff2105a2f3
Update tests/test_ext_napoleon_docstring.py 2022-01-15 17:31:23 +00:00
James Hilton-Balfe
d52adad64e Fix formatting 2022-01-15 14:04:38 +00:00
James Hilton-Balfe
dc60b1db76 Add a test for this 2022-01-15 13:59:25 +00:00
Takeshi KOMIYA
e2f141620d Fix a flake8 warning 2022-01-15 20:01:30 +09:00
Takeshi KOMIYA
6611140c76 Merge branch '4.x' into HEAD 2022-01-15 19:46:45 +09:00
danieleades
18d7dfbd95
Update tests/test_ext_napoleon.py 
Co-authored-by: Takeshi KOMIYA <i.tkomiya@gmail.com>
 2022-01-14 08:58:02 +00:00
Takeshi KOMIYA
008005cc39 Fix #9981: std domain: Strip value part of the option directive from genindex 2022-01-14 02:25:00 +09:00
Daniel Eades
6697ed62ed address some unused loop control variables (B007) 2022-01-12 20:19:18 +00: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
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