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,245 Commits 2 Branches 219 Tags 163 MiB
dd2ff3e911
Commit Graph

3326 Commits

Author SHA1 Message Date
Juan Luis Cano Rodríguez
e75f31ad47 Add link to third-party sphinx-themes 2021-06-21 07:11:22 +02:00
Juan Luis Cano Rodríguez
6f71c7bd7e Use absolute links for Sphinx documentation references 2021-06-21 07:09:19 +02:00
Juan Luis Cano Rodríguez
fb236053ab Apply style suggestions from code review 
Co-authored-by: Eric Holscher <25510+ericholscher@users.noreply.github.com>
 2021-06-21 07:04:44 +02:00
Takeshi KOMIYA
d10c9deb2c
Merge pull request #9336 from tk0miya/9032_docs 
Fix #9032: docs: sphinx.environment.NoUri was removed at v3.0.0
 2021-06-21 03:04:02 +09:00
Jakob Lykke Andersen
50f5280603 C, keyword changes 
- Add new keywords from C23.
- Add c_extra_keywords as confval.
- Move macro names from keywords to c_extra_keywords.

Fixes sphinx-doc/sphinx#9354
 2021-06-17 08:29:39 +02:00
Juan Luis Cano Rodríguez
5a057d3da1 Actually use new theme 2021-06-17 01:01:34 +02:00
Juan Luis Cano Rodríguez
e022872f3b Add section about cross-references 2021-06-17 00:37:32 +02:00
Juan Luis Cano Rodríguez
57b0a1b465 Add section about the toctree 2021-06-17 00:31:53 +02:00
Juan Luis Cano Rodríguez
2058acc4f9 Add local table of contents 2021-06-17 00:21:42 +02:00
Juan Luis Cano Rodríguez
1e49218993 Add tutorial section about extensions and themes 2021-06-17 00:21:42 +02:00
Juan Luis Cano Rodríguez
dc5dc61e3f Turn plain image into figure 2021-06-16 19:49:37 +02:00
Juan Luis Cano Rodríguez
167828fde9 Add section about exporting to other formats 2021-06-16 19:49:37 +02:00
Juan Luis Cano Rodríguez
1cbaf7ff30 Minor style fixes 2021-06-16 19:49:37 +02:00
Juan Luis Cano Rodríguez
5e7c011b92 Fix broken link to third-party extensions 2021-06-16 18:32:02 +02:00
Jean-François B
e0b1e1002b
Merge pull request #9332 from jfbu/latex_doc_9321_utf8x 
Closes: #9321 (LaTeX utf8x usage doc)
 2021-06-16 17:25:03 +02:00
jfbu
35f37a5d03 Same Unicode char replaced 2021-06-14 22:48:04 +02:00
Juan Luis Cano Rodríguez
d92c111ffb Fix whitespace in definition list 2021-06-14 22:45:54 +02:00
Juan Luis Cano Rodríguez
d65acfc1cc Fix another accidental reflow 2021-06-14 22:45:12 +02:00
Juan Luis Cano Rodríguez
ce0f165bae Fix more accidental rewrap 2021-06-14 21:39:25 +02:00
ocket8888
9db8775ba7
Update example to use recommended usage 2021-06-14 11:21:28 -06:00
Juan Luis Cano Rodríguez
95e49a1c83 Replace non-ASCII character 2021-06-14 19:14:08 +02:00
Juan Luis Cano Rodríguez
956d311809 Fix accidental rewrap 2021-06-14 19:07:25 +02:00
Takeshi KOMIYA
62f128700e Fix #9032: docs: sphinx.environment.NoUri was removed at v3.0.0 
Our deprecation list describes `sphinx.environment.NoUri` was removed at
v4.0.0.  But, acutally, it was removed at v3.0.0 (#6223).
 2021-06-14 02:18:01 +09:00
jfbu
9dbf2c9a98 Closes: #9321 (LaTeX utf8x usage doc) 2021-06-13 12:29:39 +02:00
Takeshi KOMIYA
519cc078fd Revert the removal of sphinx.util:force_decode() 
After the release of 4.0.0, some 3rd party extensions have became not
working with the latest Sphinx because `force_decode()` function was
removed.  It was deprecated since Sphinx-2.0 and warned for the removal
since 3.0.

This reverts the removal and extends its deprecation period to 5.0.0.  I
hope it helps users of these extensions.
 2021-06-13 16:31:33 +09:00
Juan Luis Cano Rodríguez
aee105ce46 Rewrap text 2021-06-06 17:19:39 +02:00
Juan Luis Cano Rodríguez
a2a8a07430 Adjust line length 2021-06-06 10:56:23 +02:00
Juan Luis Cano Rodríguez
1ffbfa72f1 Merge branch '4.x' into new-tutorial 2021-06-06 10:49:07 +02:00
Takeshi KOMIYA
b6245266ab
Merge pull request #9303 from tk0miya/fix_docslint 
doc: Fix docslint misunderstanding scope of code-blocks
 2021-06-06 13:33:17 +09:00
Takeshi KOMIYA
e0500f7354 doc: Fix docslint misunderstanding scope of code-blocks 2021-06-06 13:24:06 +09:00
Takeshi KOMIYA
1418e3acbb
Merge pull request #9260 from tk0miya/9016_linkcheck_github_anchors 
Close #9016: linkcheck builder failed to check the anchors of github.com
 2021-06-04 01:18:22 +09:00
Juan Luis Cano Rodríguez
565713d228 Change Pygments lexer to account for prompt 2021-05-31 18:03:04 +02:00
Takeshi KOMIYA
92335bd6e6 Close #9016: linkcheck builder failed to check the anchors of github.com 2021-06-01 00:31:15 +09:00
Juan Luis Cano Rodríguez
ce727e3cfe More style changes 2021-05-31 16:35:35 +02:00
Juan Luis Cano Rodríguez
2b0131d0bc Be consistent with virtual environment name 2021-05-31 16:29:55 +02:00
Juan Luis Cano Rodríguez
c8a3a2535a Be consistent with directory names 2021-05-31 16:29:09 +02:00
Juan Luis Cano Rodríguez
95519b3c06 Links to relevant reST syntax explanation 2021-05-31 16:26:21 +02:00
Juan Luis Cano Rodríguez
1da5ab5808 Style fixes 
Co-authored-by: Steve Piercy <web@stevepiercy.com>
 2021-05-31 16:26:21 +02:00
Takeshi KOMIYA
988a79de65 linkcheck: Emit a warning for disallowed redirects 
Now linkcheck builder integrates `linkcheck_warn_redirects` into
`linkcheck_allowed_redirects`.  As a result, linkcheck builder will
emit a warning when "disallowed" redirection detected via
`linkcheck_allowed_redirects`.
 2021-05-31 21:53:09 +09:00
Takeshi KOMIYA
2887dd07df
doc: Fix indentation 2021-05-31 02:59:35 +09:00
Takeshi KOMIYA
48c80b17b4
doc: Fix indentation 2021-05-31 02:58:29 +09:00
Takeshi KOMIYA
676834b998
Merge branch '4.x' into 6525_linkcheck_warn_redirects 2021-05-31 02:54:41 +09:00
Takeshi KOMIYA
fe89a07a92
Fix typo in doc/usage/configuration.rst 
Co-authored-by: François Freitag <mail@franek.fr>
 2021-05-31 02:54:17 +09:00
Takeshi KOMIYA
46c2e45aa6 deprecate sphinx.ext.autosummary._app 2021-05-31 02:09:10 +09:00
Juan Luis Cano Rodríguez
bfca913f16 Move virtual environment explanation to installation 2021-05-29 19:15:15 +02:00
Juan Luis Cano Rodríguez
5b3e5d887b Amend code documentation introduction 2021-05-29 13:44:26 +02:00
Juan Luis Cano Rodríguez
d6cb2d0c38 Use more appropriate terminology for emphasized text 2021-05-29 13:22:36 +02:00
Juan Luis Cano Rodríguez
bfd3b51435 Style 2021-05-29 13:22:21 +02:00
Juan Luis Cano Rodríguez
1631291b0e Consistent heading styles 2021-05-29 13:21:50 +02:00
Juan Luis Cano Rodríguez
ffa8e110d0 Add index tweaks 2021-05-27 21:32:49 +02:00
Juan Luis Cano Rodríguez
337ee6afaa Style 2021-05-27 18:17:33 +02:00
Juan Luis Cano Rodríguez
39b5564c63 Beginning of the tutorial, tweaks to introduction 2021-05-27 18:15:26 +02:00
Grey Li
6a0dae08d0
Fix typo in doc/intl.rst 
The pot files are in the gettext folder instead of locale folder.
 2021-05-27 17:28:10 +08:00
Juan Luis Cano Rodríguez
70ee9bcd6a Tutorial link in front page, audience, objectives, and prerequisites 2021-05-26 21:25:38 +02:00
Takeshi KOMIYA
abe5ab4fa7
Merge pull request #9242 from tk0miya/refactor_env2 
refactor: Make the app argument for BuildEnvironment required
 2021-05-22 02:22:42 +09:00
Takeshi KOMIYA
63fbfb02f1 refactor: Make the app argument for BuildEnvironment required 
At present, some attributes of env object are considered as optional
because they have been initialized by None on the constructor.  But
they have always been fullfilled actually.

To be clear the type hints of the env object, this makes the `app`
argument for the BuildEnvironment class required.  It can ensure the
attributes of env object are not optional.
 2021-05-22 02:09:49 +09:00
Takeshi KOMIYA
c97e9b14c4 Update docs 2021-05-20 23:43:34 +09:00
Takeshi KOMIYA
ce9e2e6c74 Rename linkcheck_ignore_redirects to linkcheck_allowed_redirects 2021-05-20 23:26:16 +09:00
Takeshi KOMIYA
4d061f2b49 Fix #9252: doc: Update explanation of highlight_language 2021-05-20 02:07:01 +09:00
Takeshi KOMIYA
549f09e048
Merge pull request #9239 from igo95862/https-links 
Upgrade URLs to use HTTPS
 2021-05-19 22:59:19 +09:00
igo95862
0f4039ab56
doc: Fixed opensearch.org link and upgraded to HTTPS 2021-05-17 20:39:14 +03:00
igo95862
82f37344b0
doc: Upgraded dublincore.org link to HTTPS 2021-05-17 20:39:14 +03:00
igo95862
cb004cc046
doc: Upgrade example.com links to HTTPS 2021-05-17 20:39:14 +03:00
igo95862
3f0a840c54
doc: Upgraded plantuml.org link to HTTPS 2021-05-17 20:39:14 +03:00
igo95862
b6c2edb5ca
doc: Upgraded mathjax documentation link to HTTPS 2021-05-17 20:39:14 +03:00
igo95862
bb173a5789
doc: Moved flask links to new home and HTTPS 
Seems like Flask is no longer pocoo project but
palletsprojects.com
 2021-05-17 20:39:13 +03:00
igo95862
cfa449624d
doc: Moved Jinja links to new home page and HTTPS 
Seems like Jinja is no longer pocoo project but
palletsprojects.com
 2021-05-17 20:38:48 +03:00
Takeshi KOMIYA
bc7087a1a2
Merge branch '4.x' into 3014_autodoc-process-bases 2021-05-17 22:40:27 +09:00
igo95862
7554ad9593
doc: Upgraded babel.pocoo.org links to HTTPS 2021-05-16 16:37:51 +03:00
igo95862
29aaf20a11
doc: Upgraded some of sphinx-doc.org links to HTTPS 
Seems like that link is used in some tests and code so
upgrading it outside documentation might break something
 2021-05-16 16:37:36 +03:00
igo95862
6c5f77c689
doc: Upgrade pygments.org links to HTTPS 2021-05-16 15:53:58 +03:00
igo95862
e67c9e5df1
doc: Upgrade docutils.sourceforge.io links to HTTPS 
Also change any docutils.sourceforge.net link to io
top level domain.
 2021-05-16 15:53:49 +03:00
igo95862
28b9475019
doc: Upgrade writethedocs.org domain link to HTTPS 2021-05-16 15:08:18 +03:00
Takeshi KOMIYA
630e5bd15f manpage: Stop creating a section directory on build manpage by default 2021-05-16 17:06:58 +09:00
Takeshi KOMIYA
8d87dde43b
Merge pull request #9232 from tk0miya/9217_dont_make_section_directory 
manpage: Stop creating a section directory on build manpage by default
 2021-05-16 17:02:41 +09:00
Takeshi KOMIYA
707319aab2 Close #6525: linkcheck: Add linkcheck_ignore_redirects 
Add a new confval; linkcheck_ignore_redirects to ignore hyperlinks
that are redirected as expected.
 2021-05-16 02:48:03 +09:00
Takeshi KOMIYA
05eb2ca06f Close #6525: linkcheck: Add linkcheck_warn_redirects 
Add a new confval; `linkcheck_warn_redirects` to emit a warning when
the hyperlink is redirected.  It's useful to detect unexpected redirects
under the warn-is-error mode.
 2021-05-16 02:29:03 +09:00
Takeshi KOMIYA
51ae283a38 Close #4257: autodoc: Add autodoc_class_signature 
Add `autodoc_class_signature` to separate the class entry and the
definition of `__init__()` method.
 2021-05-16 01:53:48 +09:00
Takeshi KOMIYA
67db20d705 Close #3014: autodoc: Add autodoc-process-bases 
Add `autodoc-process-bases` to modify the base classes of the class
definitions.  This allows the extensions to insert or modify the list
of the base classes via event-handlers.
 2021-05-16 00:46:06 +09:00
Takeshi KOMIYA
fa8117cd2f manpage: Stop creating a section directory on build manpage by default 2021-05-15 22:23:40 +09:00
Takeshi KOMIYA
5078069eb1 Deprecate app.html_themes 
The register is much better to store the HTML themes instead of the
application object.  So this migrates it to the registry object.
 2021-05-12 01:36:14 +09:00
Takeshi KOMIYA
c341807991
Merge pull request #9185 from AWhetter/autodoc_typehints_both 
autodoc.typehints can accurately represent overloads
 2021-05-12 00:23:58 +09:00
Takeshi KOMIYA
0b0414ea17
Update "versionadded" in doc/usage/extensions/autodoc.rst 2021-05-12 00:04:43 +09:00
Dmitry Shachnev
356f7c53e2 Fix typos in doc/extdev/deprecated.rst 2021-05-09 20:14:38 +03:00
Ashley Whetter
28d3f8136e autodoc.typehints can accurately represent overloads 2021-05-08 21:34:25 -07:00
Takeshi KOMIYA
ac51fe8d2a doc: Update CHANGES and docs for PR #9176 2021-05-09 02:13:15 +09:00
Takeshi KOMIYA
d82c8a7890
Merge pull request #9131 from RuRo/feature/glob-nitpick-ignore 
Ignore nitpick warnings with regular expressions using `nitpick_ignore_regex`
 2021-05-05 23:43:46 +09:00
Takeshi KOMIYA
30efa3d947
Merge branch '4.x' into 8597_metadata_only_docstring 2021-05-03 22:11:10 +09:00
Takeshi KOMIYA
469def56b6 Fix #8597: autodoc: metadata only docstring is treated as undocumented 
The metadata in docstring is invisible content. Therefore docstring
having only metadata should be treated as undocumented.
 2021-05-02 23:17:58 +09:00
ruro
104d0a3f69
describe nitpick_ignore_regex in docs 2021-05-02 13:31:13 +03:00
Takeshi KOMIYA
d8a9f243e2 Close #8107: autodoc: Add class-doc-from option to autoclass directive 
Add `class-doc-from` option to the `autoclass` directive to control
the content of the specific class.  It takes `class`, `init`, and `both`
like `autoclass_content`.
 2021-05-01 14:53:06 +09:00
Takeshi KOMIYA
d8fa067583 Add doc and testcase for program directive (refs: #9137) 
There is no docs and testcases for "None" argument of the program
directive.  It has been implemented since very old version.  But it's
not documented and tested long.
 2021-04-28 02:16:57 +09:00
Takeshi KOMIYA
4e9d155396 Merge branch '4.0.x' into 4.x 2021-04-25 21:34:02 +09:00
Takeshi KOMIYA
cb78512835 doc: Fix minor mark-up misses up 2021-04-24 18:37:30 +09:00
Matthias Geier
778faffecc Add documentation for mathjax2_config and mathjax3_config 2021-04-24 18:30:44 +09:00
Matthias Geier
7b9cc0563d Add documentation for mathjax2_config and mathjax3_config 2021-04-24 10:50:37 +02:00
Takeshi KOMIYA
53dff4ef5f Merge branch '4.0.x' into 4.x 2021-04-20 01:45:12 +09:00
Takeshi KOMIYA
aeb00d8186 doc: Fix typo 2021-04-20 01:13:48 +09:00
Takeshi KOMIYA
ff02add8ef
Merge pull request #9101 from V0lantis/fix/fix_user_selection 
Fix `user-selection` in Safari and Internet Explorer
 2021-04-20 01:10:15 +09:00
Takeshi KOMIYA
668bc9eec9 Merge branch '4.0.x' into 4.x 2021-04-19 01:08:54 +09:00
Takeshi KOMIYA
8ec937d4c9
Merge pull request #9050 from tk0miya/8829_whats_parallel_read_safe 
Close #8829: doc: Update description of paralle-read-safe
 2021-04-18 15:22:19 +09:00
Harmon
31718d78b4 doc: Fix grammar in documentation for autodoc_typehints 2021-04-17 17:46:31 +02:00
Juan Luis Cano Rodríguez
130ed4bb4a Recommend MyST-Parser for Markdown usage 2021-04-15 20:31:13 +02:00
Harmon
5af55008b3
doc: Fix grammar in documentation for autodoc_typehints 2021-04-14 16:41:25 -05:00
Jakob Lykke Andersen
98800be904 Decl styling, make desc_inline node 
Use the new node for cpp:expr
 2021-04-12 19:06:44 +02:00
Jakob Lykke Andersen
3c9a74cb0b Decl styling, docs and restructuring 2021-04-12 19:05:58 +02:00
Takeshi KOMIYA
32337c3ba7
Merge pull request #9084 from tk0miya/8731_docs_for_napoleon_preprocess_types 
doc: Add docs for napoleon_preprocess_types
 2021-04-13 01:15:44 +09:00
Takeshi KOMIYA
d59e96c8b4 docs: Add versionchanged tag to extlinks (refs: #8898) 2021-04-11 22:25:48 +09:00
Merry Bass
75605d437f fixup! sphinx.ext.extlinks: Clarify escaping of `%` 2021-04-11 22:14:24 +09:00
Merry Bass
ef1747f03a sphinx.ext.extlinks: Clarify escaping of `%` 
We use Pythons %-formatting, so literal ``%`` must be escaped as ``%%``.
Clarify this behaviour for the caption and base URL strings.
 2021-04-11 22:14:17 +09:00
Merry Bass
fb39974486 sphinx.ext.extlinks: Allow `%s` in link caption string 
Tweak syntax of extlinks to also allow ``%s`` in the link caption part.
Like for the base URL ``%s`` will be substituted with the content of the
role.  This allows configurations like

    extlinks = {'quarter': ('https://example.org/quaters/%s',
                          '%s. quarter')}

with ``:quarter:`2``` getting replaced by a link titled `2. quarter`.

The requirement for the caption string is to be either None or contain
exactly one ``%s``.  If neither is the case, then we emit a warning and
fall back to the old behaviour which is concatenating the caption string
with the role content.
 2021-04-11 22:14:01 +09:00
Takeshi KOMIYA
d09747f225 doc: Add docs for napoleon_preprocess_types 2021-04-11 21:35:47 +09:00
Takeshi KOMIYA
70ea4381ca
Merge pull request #8841 from AWhetter/autodoc_signatures_without_backslash 
Overloaded function signatures do not require a separating backslash
 2021-04-04 18:02:01 +09:00
Takeshi KOMIYA
02016c0ef2 Close #8829: doc: Update description of paralle-read-safe 2021-04-04 13:35:12 +09:00
Takeshi KOMIYA
41a377fee5 Merge branch '3.x' 2021-04-04 00:06:45 +09:00
Takeshi KOMIYA
ddb6e9c61c
Merge pull request #8539 from godlygeek/description_typehints_for_classes 
Make autodoc_typehints="description" work with autoclass_content="class"
 2021-04-03 23:28:08 +09:00
Brecht Machiels
ac0dcddeb8
Docs: fix typo in env-merge-info 2021-03-30 16:44:50 +02:00
Albert Villanova del Moral
260725c823
Fix minor typo 2021-03-30 08:45:34 +02:00
Matt Wozniski
4785f32ddf Add autodoc_typehint_undoc option 
Previously, if autodoc_typehints="description", a :type: field would be
added for every parameter and return type appearing in the annotation,
including **kwargs and underscore-prefixed parameters that are meant to
be private, as well as None return types.

This commit introduces a new option, "autodoc_typehint_undoc".  By
default this option is True, requesting the old behavior. By setting
this option to False, :type: and :rtype: fields will only be added for
annotated parameters or return types if there is already a corresponding
:param: or :return: field, to put users in control over whether a given
parameter is documented or not.
 2021-03-27 14:54:37 -04:00
Ashley Whetter
94b5607591 Overloaded function signatures do not require a separating backslash 2021-03-27 10:25:20 -07:00
Takeshi KOMIYA
6007bbf797 Deprecate DocumenterBridge.warn() 
Since 1.6, sphinx.util.logging module became the default logging
interface of Sphinx. It allows sphinx-components to output log
without the app (or env) object.  According to the policy,
DocumenterBridge.warn() is no longer needed and should be replaced by
the logging module.
 2021-03-22 23:51:54 +09:00
Takeshi KOMIYA
cb654d287b Rename DocumenterBridge.filename_set to record_dependencies 
DocumenterBridge.filename_set has been used since its beginning.  On the
other hand, in docutils, record_dependencies attribute is well-used to
store the list of dependency files.  So this renames it to docutils'
standard attribute.
 2021-03-21 00:52:53 +09:00
Takeshi KOMIYA
45f56dd7ac Fix #9008: Fix typo 2021-03-16 01:28:07 +09:00
Takeshi KOMIYA
e03d0aeba0
Merge pull request #8991 from tk0miya/typing_OptionSpec 
refactor: Add a type alias for the option_spec of directives; OptionSpec
 2021-03-15 13:03:15 +09:00
Tim Hoffmann
0d73a03a38 DOC: Minor cleanup of sphinx-build doc 
The moved sentence clearly belongs to the discussion of the builders.
 2021-03-15 00:27:39 +01:00
Takeshi KOMIYA
17bb78997c
Merge pull request #7298 from tk0miya/7068_pyproperty_directive 
py domain: Add py:property directive to describe a property (refs: #7068)
 2021-03-13 21:22:29 +09:00
Takeshi KOMIYA
a523a89663 refactor: Add a type alias for the option_spec of directives; OptionSpec 2021-03-13 17:15:12 +09:00
Jean-François B
1a62d89276
Merge branch 'master' into pdf_bookmarksdepth 2021-03-12 21:57:45 +01:00
Takeshi KOMIYA
204f86f736 py domain: Add py:property directive to describe a property (refs: #7068) 2021-03-11 01:56:39 +09:00
Takeshi KOMIYA
54886fd256 Close #7549: autosummary: Enable autosummary_generate by default 2021-03-10 01:35:49 +09:00
Takeshi KOMIYA
3693ffe232
Merge pull request #8972 from igo95862/master 
Tutorial for extending autodoc
 2021-03-10 01:20:05 +09:00
igo95862
7ee2000598 doc: Added reflink to autodoc tutorial 
Used in add_autodocumenter docstring
 2021-03-09 17:57:30 +03:00
igo95862
a56f69b916 doc: Added autodoc extension tutorial to tutorials index 2021-03-09 17:57:30 +03:00
igo95862
1ac05a2a83
doc: Create autodoc extension tutorial 2021-03-09 17:56:46 +03:00
Takeshi KOMIYA
fb4220d0a2 Close #8487: csv-table now considers abspath as relpath from srcdir 
To make directives' behavior consistent, the :file: option for
csv-table directive now recognizes an absolute path as a relative
path from source directory.
 2021-03-09 01:07:19 +09:00
Takeshi KOMIYA
ae413e95ed
Merge pull request #8970 from naveen521kk/patch-1 
Sphinx is available on Chocolatey
 2021-03-07 21:30:46 +09:00
Naveen M K
1b425230e3
lint 2021-03-07 00:21:41 +05:30
Naveen M K
2638e9aecc
Sphinx is available on Chocolatey 2021-03-07 00:13:40 +05:30
Takeshi KOMIYA
0dcdbdc230 doc: Fix indentation 2021-03-06 21:19:26 +09:00
Takeshi KOMIYA
008feac9ad
Merge pull request #8965 from tk0miya/refactor_doc 
doc: Update document for autodoc
 2021-03-06 20:15:24 +09:00
Takeshi KOMIYA
697fdea612 doc: Update document for autodoc :special-members: option 2021-03-06 19:12:52 +09:00
Takeshi KOMIYA
8411b9a536 doc: Update document for autodoc :private-members: option 2021-03-06 19:12:47 +09:00
Takeshi KOMIYA
009fd4c396 doc: Update document for autodoc :undoc-members: option 2021-03-06 19:12:41 +09:00
Takeshi KOMIYA
f37e679fd1 doc: Update document for autodoc :members: option 2021-03-06 19:12:34 +09:00
Takeshi KOMIYA
1ea11b1e48 Fix #759: autodoc: Add sphinx.ext.autodoc.preserve_defaults extension 
Add a new extension `sphinx.ext.autodoc.preserve_defaults`.

It preserves the default argument values of function signatures in source code
and keep them not evaluated for readability.  This is an experimental
extension and it will be integrated into autodoc core in Sphinx-4.0.
 2021-03-06 18:48:18 +09:00
Takeshi KOMIYA
0a3f897d15
Merge pull request #8432 from tk0miya/7119_pending_xref_condition 
Fix #7119: Show type hint names unqualified when resolving succeeded
 2021-03-06 17:32:27 +09:00
Takeshi KOMIYA
930a880294 Fix #7199: py domain: Add a new confval: python_use_unqualified_type_names 
Add a new config variable: python_use_unqualified_type_names.  If enabled,
it goes to suppress the module name of the python reference if it can be
resolved.
 2021-03-06 14:00:00 +09:00
Takeshi KOMIYA
e1130972b2 Add pending_xref_condition node 
To choose appropriate content for pending_xref node on resolving,
this introduces a new custom node `pending_xref_condition`.  It only
has a condition for the filtering and contents of the reference.
 2021-03-06 02:01:03 +09:00
Takeshi KOMIYA
ff49bfa003
Merge pull request #8947 from tk0miya/deprecate_registry.get_source_input 
Deprecate SphinxComponentRegistry.get_source_input()
 2021-03-05 00:06:05 +09:00
Takeshi KOMIYA
61c9c7fc58 Deprecate SphinxComponentRegistry.get_source_input() 
The source_input system was deprecated at v2.0.  So no client uses it
longer now.  Therefore this deprecate the getter interface and its
usage.
 2021-03-02 21:18:31 +09:00