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
19,362 Commits 2 Branches 219 Tags 163 MiB
4d7558e968
Commit Graph

4207 Commits

Author SHA1 Message Date
Takeshi KOMIYA
b12b39db05
Merge pull request #10212 from AA-Turner/remove-module-docstring-titles 
Remove module docstring titles
 2022-03-14 02:14:17 +09:00
Jakob Lykke Andersen
9362df53be C++, minor formatting 2022-03-12 20:05:26 +01:00
Jeremy Maitin-Shepard
a9a5cec681
Update tests/test_domain_cpp.py 
Co-authored-by: Jakob Lykke Andersen <jakobandersen@users.noreply.github.com>
 2022-03-11 05:03:05 -08:00
Jeremy Maitin-Shepard
2c1e4c437e
Update tests/test_domain_cpp.py 
Co-authored-by: Jakob Lykke Andersen <jakobandersen@users.noreply.github.com>
 2022-03-11 05:02:59 -08:00
Jeremy Maitin-Shepard
ce82f9ee9c
Update tests/test_domain_cpp.py 
Co-authored-by: Jakob Lykke Andersen <jakobandersen@users.noreply.github.com>
 2022-03-11 05:02:54 -08:00
Jeremy Maitin-Shepard
670e8b149f [C++] Support attributes on class and union and improve formatting 2022-03-10 22:03:42 -08:00
Adam Turner
f05a068be9 Fix whitespace 2022-03-07 15:17:45 +00:00
Takeshi KOMIYA
f7a0107ddb Merge branch '4.x' 2022-03-03 02:28:07 +09:00
Takeshi KOMIYA
37e8967f3f Merge branch '4.4.x' into 4.x 2022-03-03 02:24:53 +09:00
Takeshi KOMIYA
12104fe5de test: Follow the new behavior of typing.get_type_hints() since py311 
Since python-3.11, `typing.get_type_hints()` will not add Optional[t] to
type annotations even if a default value for function argument is None.

refs: https://github.com/python/cpython/pull/30304 (bpo-46195)
 2022-03-03 01:34:21 +09:00
Adam Turner
5775912455 Collapse single line docstrings 2022-02-20 03:13:45 +00:00
Adam Turner
6bb7b891a1 Remove copyright and licence fields 2022-02-20 03:06:23 +00:00
Adam Turner
b691ebcc3e Conform to PEP 257 summary line conventions 2022-02-20 02:57:02 +00:00
Adam Turner
5694e0ce60 Fix module docstring indentation 2022-02-20 00:35:13 +00:00
Adam Turner
4f5a3269a6 Fix module docstring first line 2022-02-20 00:11:08 +00:00
Adam Turner
6b8bccec59 Remove module titles in docstrings 2022-02-19 23:17:29 +00: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
8b23f6db12 Merge commit '07110b7557a552ecfe702bdd6a2d2f9685cb1af9' 2022-02-14 03:03:40 +09:00
Takeshi KOMIYA
01d06f9ffe Fix #10175: LaTeX: named footnote ref is linked to an incorrect footnote 
A named footnote reference will be converted to a hyperlink to an
incorrect footnote if the name is also used in the different document.
 2022-02-13 20:20:42 +09:00
Takeshi KOMIYA
6f0a8f3516
Merge pull request #10189 from tk0miya/https_pep_role 
The latest docutils converts :pep: role to the "https" URL (again)
 2022-02-13 19:34:39 +09:00
Takeshi KOMIYA
9d29adb76c The latest docutils converts :pep: role to the "https" URL (again) 
docutils-0.19 (unreleased) generates "https" URL from :pep: role.
 2022-02-13 19:22:17 +09:00
Takeshi KOMIYA
9ea2b768b0
Merge pull request #10185 from tk0miya/10181_napoleon_use_ivar_corrupted 
Fix #10181: napoleon_use_ivar adds unexpected prefix to vars
 2022-02-13 18:46:14 +09:00
Takeshi KOMIYA
b07ca9dbcc
Merge pull request #10170 from tk0miya/https_pep_role 
The latest docutils converts :pep: role to the "https" URL
 2022-02-13 18:44:55 +09:00
Takeshi KOMIYA
8224f6f44a Fix #10181: napoleon_use_ivar adds unexpected prefix to vars 
Since 4.0, :ivar: items has not been rendered as hyperlinks.  So any
modules, classes and tilda are now harmful.  This removes the prefixing
filter for napoleon_use_ivar option.

refs: #5129 and #5977
 2022-02-12 00:50:56 +09:00
Takeshi KOMIYA
777b1fa105 Merge branch '4.x' into 9529_named_footnotes_in_latex 2022-02-11 13:08:26 +09:00
Takeshi KOMIYA
b6931acac6
Merge pull request #10168 from tk0miya/9529_testcase_for_named_footnote 
test: Add testcase for named footnotes
 2022-02-11 13:06:01 +09:00
Stephen Finucane
105c583f06 Revert "Close #9993: std domain: Allow to refer an inline target via ref role" 
This reverts commit e3ee8b378a. This is a
breaking change that should not have been introduced in a minor release
(or arguably at all, given the impact).

Signed-off-by: Stephen Finucane <stephen@that.guru>
Closes: #10177
 2022-02-08 16:00:01 +00:00
Takeshi KOMIYA
083b0b5207 The latest docutils converts :pep: role to the "https" URL 
docutils-0.19 (unreleased) generates "https" URL from :pep: role.
 2022-02-06 23:10:25 +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
1546b21f89 Fix #9529: LaTeX: named footnotes are converted to "?" 
Named auto numbered footnote (ex. ``[#named]``) that is referred
multiple times was rendered to a question mark.

This calls `\sphinxstepexplicit` for every footnote node that is
referred multiple times.
 2022-02-06 15:59:01 +09:00
Takeshi KOMIYA
9b142f15e6 test: Add testcase for named footnotes 2022-02-06 14:33:29 +09:00
Takeshi KOMIYA
8c1671bd35
Merge pull request #10094 from tk0miya/9777_new_html_structure_of_du18 
test: Follow the new HTML structure of docutils-0.18
 2022-02-05 21:25:03 +09:00
Adam Turner
3b01fbe2ad
Drop JavaScript Frameworks (#10028) 
* Delete jQuery and underscore.js

* Move underscores.js setup to searchtools.js

* Update jQuery.url(en|de)code

* Update jQuery.getQueryParameters

* Firefox bug is no longer present

xref https://bugzilla.mozilla.org/show_bug.cgi?id=645075#c49

* Update jQuery.fn.highlightText

* Use enum instead of magic number

* Update test descriptions to remove obsolete jQuery reference

* Update Documentation.getCurrentURL

* Revert accidental fix of Documentation.getCurrentURL

* Update Documentation.initOnKeyListeners

* Update Documentation.hideSearchWords

* Update Documentation.highlightSearchWords

* Update Documentation.initDomainIndexTable

* Use arrow functions and const

* Replace $(document).ready

* Strict mode

* Move Documentation.hideSearchWords next to Documentation.highlightSearchWords

* Update translation functions in Documentation

* Replace $(document).ready in searchtools.js

* Update Scorer

* Update Search.hasIndex, Search.deferQuery, Search.stopPulse

* Prefer window.location

* Update Search.init

* Update Search.loadIndex

* Update Search.setIndex

* Update Search.startPulse

* Add _escapeRegExp

* Update Search.makeSearchSummary

* Update Search.htmlToText

* Update Search.performSearch

* Factor out _displayNextItem

* Update Search.query

* Update Search.performObjectSearch

* Update Search.performTermsSearch

* Remove underscores.js setup

* Use Sets

* Update test configuration

* Fix test failures

* Drop unused make/get URL functions

* Strict mode in searchtools.js

* Remove outmoded check for jQuery and underscore.js

* Ran prettier

prettier --print-width 120 --no-semi --quote-props as-needed --no-bracket-spacing --arrow-parens avoid --write sphinx/themes/basic/static

* Remove more references to jQuery and underscore.js

* Remove jQuery and underscore.js licences

* Update classic theme for no jQuery

* Update all other themes for no jQuery

* Restore jQuery & underscores.js to Sphinx themes

Enables a more gradual deprecation

* Added deprecation note to CHANGES

* Run prettier with defaults

* Update deprecation message to include extensions, note that sources must be copied

* oops

* Address Pradyun's feedback

* Forgot this one

* `let` doesn't work, as it is scoped to the block...

* Remove missed jQuery in sphinx13 theme
 2022-01-30 20:27:12 +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
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
Takeshi KOMIYA
444dfc50aa Merge branch '4.x' 2022-01-17 00:22:09 +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
Takeshi KOMIYA
6a0215198f Merge branch '4.x' 2022-01-16 02:26:11 +09: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
Takeshi KOMIYA
48dc4b8a96 test: Follow the new HTML structure of docutils-0.18 
Since docutils-0.18, the HTML structure for citations and footnotes has
been changed.  This modifies our testcase to follow the new HTML structure.
 2022-01-13 02:12:37 +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
e4e58a4f27 Close #10062: Change the default language to 'en' 
Change the default language to `'en'` if any language is not set in
`conf.py`.
 2022-01-12 02:45:52 +09:00
Daniel Eades
61ff90460d use 'callable' to check if object is callable (B004) 2022-01-10 13:51:35 +00:00
Takeshi KOMIYA
b90a52c93c Merge branch '4.x' 2022-01-09 01:19:59 +09: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
3cb680acb6
Merge pull request #10048 from pradyunsg/change-heading-anchor-tooltip 
Change "headline" to "heading"
 2022-01-03 01:09:47 +09:00
Takeshi KOMIYA
a0e44a7300 test: Migrate to Node.findall() from Node.traverse() 2022-01-03 01:06:20 +09:00
Takeshi KOMIYA
b21b90d292 Merge branch '4.x' 2022-01-03 01:01:06 +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
Pradyun Gedam
bc635627d3
Change "Permalink to this {headline -> heading}" 
"heading" is a better word to use in this tooltip, since it better
matches the use case.
 2022-01-02 18:32:30 +05:30
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
6f707a0944 Merge branch '4.x' 2022-01-02 17:24:12 +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
ce8039db1f Merge branch '4.x' 2022-01-01 20:04:19 +09:00
Takeshi KOMIYA
f38bd8e952 Merge branch '4.3.x' into 4.x 2022-01-01 20:02:10 +09:00
Takeshi KOMIYA
6ee3dd1968 Merge branch '4.x' 2022-01-01 19:02:09 +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
jfbu
559e4d3707 Merge branch 'master' into 9985_latex_on_master 2021-12-23 18:26:22 +01:00
Takeshi KOMIYA
4e8bca2f2f Merge branch '4.x' 2021-12-24 00:30:29 +09:00
jfbu
cc8e59e722 Merge branch 'master' into 9985_latex_on_master 2021-12-22 19:51:15 +01:00
jfbu
4235195e77 Fix a spelling typo in tests (s/änhlich/ähnlich) 2021-12-22 12:44:28 +01: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
jfbu
9e8e3f9a6e LaTeX: separate terms from their definitions by a CR (fix #9985) 2021-12-20 18:47:53 +01: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
gschwaer
1caf4823f2 feat: add tests and fix None rtype 2021-11-29 20:06:37 +01: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
Josh Mitchell
8e45229fee Fixed missed ignore___all__ -> ignore_module_all 2021-11-15 13:27:26 +11: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
Martin Liska
9ec829fb50 texinfo: simplify reference emission. 
The commit adds a new config value 'texinfo_emit_document_references'
that blocks the emission of inline references and make it better readable
with legacy stand-alone reader ``info``.

Before the change we emit:
Default option value for @ref{e,,-Wshift-overflow3}.

while with texinfo_emit_document_references == True:
Default option value for -Wshift-overflow3.

It addresses limitations mentioned in Sphinx' FAQ:
https://www.sphinx-doc.org/en/master/faq.html#texinfo-info
 2021-11-12 14:00:48 +01:00
oleg.hoefling
8356260554
extlinks: replacement suggestions for hardcoded links 
Signed-off-by: oleg.hoefling <oleg.hoefling@gmail.com>
 2021-11-12 09:38:59 +01:00
Takeshi KOMIYA
1317eeedae
Merge pull request #9828 from tk0miya/9618_gettext_allow_fuzzy_translations 
Close #9618: i18n: Add gettext_allow_fuzzy_translations
 2021-11-10 01:45:07 +09:00