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,736 Commits 2 Branches 219 Tags
8224f6f44adb842968c696c890c04f74e4ea60d5
Commit Graph

4063 Commits

Author SHA1 Message Date
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
Kian-Meng, Ang
5161341b3e Fix typos 2021-11-30 05:48:44 +08:00
Takeshi KOMIYA
5eaed2bed7 py domain: Allow "~" prefix as a prefix of typehints in signature 
Now python domain supports the "~" prefix at the beginning of the
typehints of the function signatures:

  .. py:function:: func(x: ~typing.Dict)

It's rescognized as the same as python reference roles do
(ex. :py:class:`~typing.Dict`).
 2021-11-30 01:54:23 +09:00
Takeshi KOMIYA
a3edc982c1 Merge pull request #9902 from tk0miya/9899_pydomain_crossref_specifier_in_typefield 
Fix #9899: py domain: Allows cross-reference specifier to :type: option
 2021-11-30 01:43:51 +09: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
e25589ca1d Merge branch '4.x' into 9899_pydomain_crossref_specifier_in_typefield 2021-11-30 01:37:04 +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
acaf70596e Fix #9899: py domain: Allows cross-reference specifier to :type: option 2021-11-29 00:32:56 +09:00
Takeshi KOMIYA
17467b7ae2 test: Try to import nodes.meta first (for the latest docutils) 2021-11-28 13:01:50 +09:00
Takeshi KOMIYA
2b0ba5089b Merge remote-tracking branch 'origin/4.x' into 4.x 2021-11-26 02:55:56 +09:00
Takeshi KOMIYA
f2295d2f07 Merge branch '4.3.x' into 4.x 2021-11-26 02:55:41 +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
c8f019ab50 Fix #9868: ImportError on testing sphinx.util.inspect 
In some Linux distribution, ImportError is raised on testing
sphinx.util.inspect because _testcapi is not installed.
 2021-11-23 18:22:08 +09:00
Takeshi KOMIYA
259de307ca Merge branch '4.3.x' into 4.x 2021-11-23 18:17:13 +09:00
Josh Mitchell
73b7cd51ea Fix lints and reorder args of members_of 2021-11-22 13:57:56 +11: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
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
Matt Ficke
2ed4bed33a Update RFC base url 
The tools.ietf.org subdomain is being wound down and services are moving to
datatracker.ietf.org. Links to RFC documents using the old subdomain are being
redirected to datatracker; this updates the configured `rfc_base_url` to
point to the current subdomain.

Discussion: https://mailarchive.ietf.org/arch/msg/ietf/0n-6EXEmkTp3Uv_vj-5Vnm3o0bo/
 2021-11-16 10:52:02 -05:00