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
21,214 Commits 2 Branches 219 Tags 163 MiB
fadb6b10cb
Commit Graph

322 Commits

Author SHA1 Message Date
Takeshi KOMIYA
f731bf1999 Merge branch '5.x' into autodoc_force_undocumented_rtype 2022-04-03 22:29:22 +09:00
Takeshi KOMIYA
21e3a96f09 Close #8417: autodoc: :inherited-members: option now takes multiple classes 
It allows to suppress inherited members of several classes on the module at
once by specifying the option to `automodule` directive
 2022-04-03 20:17:41 +09:00
Takeshi KOMIYA
2db180da70 Merge branch '4.x' 2022-03-27 19:47:11 +09:00
Takeshi KOMIYA
c6230dc4db extlinks: Disable hardcoded links detector by default (refs: #10126) 
The hardcoded links detector added since 4.4.0 causes troubles in many
projects.  Therefore, this disables it by default, and adds a new
configuration `extlinks_detect_hardcoded_links` to enable it explicitly.
 2022-03-27 15:22:11 +09:00
Takeshi KOMIYA
fbdfade068 doc: Use :pep: role to refer PEP documents 2022-03-27 01:46:22 +09:00
Hugo van Kemenade
a432bf8c10 Update PEP links in docs 2022-03-24 12:34:05 +02:00
Takeshi KOMIYA
f72cd83e4d Merge branch '4.x' 2022-02-19 16:08:05 +09:00
Takeshi KOMIYA
8b23f6db12 Merge commit '07110b7557a552ecfe702bdd6a2d2f9685cb1af9' 2022-02-14 03:03:40 +09:00
Takeshi KOMIYA
7469096e0a
Update doc/usage/extensions/autodoc.rst 2022-02-06 15:30:54 +09:00
Takeshi KOMIYA
b0b51cecc2 Close #10146: autodoc: autodoc_default_options does not support no-value option 2022-01-31 01:51:37 +09:00
Timo Cornelius Metzger
8f39f29725 Update autosummary.rst 2022-01-27 20:22:45 -08:00
Takeshi KOMIYA
444dfc50aa Merge branch '4.x' 2022-01-17 00:22:09 +09:00
Jakob Lykke Andersen
3bf8bcd6e1 intersphinx role, update docs 2022-01-16 09:48:20 +01:00
Jakob Lykke Andersen
540d76035c intersphinx role, documentation 2022-01-16 09:48:06 +01:00
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
6ee3dd1968 Merge branch '4.x' 2022-01-01 19:02:09 +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
4e8bca2f2f Merge branch '4.x' 2021-12-24 00:30:29 +09:00
Takeshi KOMIYA
733ac6ed5f doc: Update explanation of autodoc_unqualified_typehints (ref: #9931) 2021-12-18 15:26:42 +09:00
Takeshi KOMIYA
0e51ddef34 Merge branch '4.x' 2021-12-11 23:18:46 +09: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
gschwaer
33bebf5e87 docs: add new option to documentation 2021-11-29 20:08:23 +01:00
Takeshi KOMIYA
c45bf2ea32 Merge branch '4.x' 2021-11-28 01:09:10 +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
fae10db6ca Merge branch '4.x' 2021-11-23 18:17:32 +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
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
Jakob Lykke Andersen
68abc2a122 Change default value of intersphinx_disabled_reftypes 
See discussion in sphinx-doc/sphinx#9459
 2021-10-31 15:01:08 +01:00
Jakob Lykke Andersen
4c19d9f65a Merge branch '4.x' 2021-10-31 14:44:45 +01:00
Jakob Lykke Andersen
56002be5e1 rename intersphinx_disabled_{refs -> reftypes} 
And change format for domains to {name}:*
 2021-10-31 13:56:26 +01:00
Jakob Lykke Andersen
484d74ad97 intersphinx_disabled_refs, doc default value 2021-10-31 13:42:26 +01:00
Jakob Lykke Andersen
cfbac2ceaa intersphinx_disabled_refs, rename 'all' to '*' 2021-10-31 13:23:23 +01:00
Jakob Lykke Andersen
0d9f4cd469 Generalize to disable specific refs as well. 2021-10-31 13:15:47 +01:00
Jakob Lykke Andersen
c88c718397 Fix typo 2021-10-31 13:15:47 +01:00
Jakob Lykke Andersen
f22faa7e06 Add intersphinx_disabled_domains 
Fixes sphinx-doc/sphinx#2068
Replaces sphinx-doc/sphinx#8981
 2021-10-31 13:15:47 +01:00
Takeshi KOMIYA
080bb71afa Merge branch '4.x' 2021-10-23 01:25:00 +09:00
Gabe R
1bc98b7860
Add missing space in intersphinx doc 
There was a space missing between `-m` and `sphinx.ext.intersphinx` in the example of showing all mappings in a intersphinx file. I added it in.
 2021-10-19 11:33:23 -07:00
Takeshi KOMIYA
3f51f1a6cf Merge branch '4.x' 2021-10-09 13:50:50 +09:00
Takeshi KOMIYA
481c5e9c4b
Merge pull request #9534 from astrojuanlu/new-tutorial-describing-code 
New Sphinx tutorial, part III
 2021-10-09 13:05:48 +09:00
Takeshi KOMIYA
d13b86e02f Close #9664: autodoc: autodoc-process-bases supports reST snippet 
This allows to inject a reST snippet through autodoc-process-bases
event.  It helps to modify the base classes of any class to the expected
mark-up'ed text by custom extension.
 2021-09-23 10:59:01 +09:00
Takeshi KOMIYA
3d8fbd992c Merge branch '4.x' 2021-09-12 16:56:34 +09:00
Takeshi KOMIYA
8416813168
Merge pull request #9616 from jdufresne/fix-url 
Update Sphinx url: s|https?://sphinx-doc\.org/|https://www.sphinx-doc.org/|g
 2021-09-11 17:16:47 +09:00
Takeshi KOMIYA
2c21e91b5f Merge branch '4.x' 2021-09-11 17:13:21 +09:00
Christian Clauss
86583c578c Fix typos discovered by codespell 2021-09-08 02:15:25 +02:00
Jon Dufresne
7dd112b110 Update Sphinx url: s|https?://sphinx-doc\.org/|https://www.sphinx-doc.org/|g 
https://sphinx-doc.org is unreachable, but is linked from the PyPI page:
https://pypi.org/project/Sphinx/. Switch to https://www.sphinx-doc.org/
instead.
 2021-09-06 13:15:48 -07:00
Nicolas Delon
bf588c42b2 Fix typo in autodoc documentation 2021-08-25 23:42:27 +02:00
Juan Luis Cano Rodríguez
a606db01f1 Add section on autosummary 2021-08-12 20:09:50 +02:00
Takeshi KOMIYA
b9a4a5d06f Merge branch '4.x' 2021-07-30 02:20:24 +09:00
Takeshi KOMIYA
6e87c17a76 doc: Add document for autoproperty directive (refs: #9486) 2021-07-23 23:10:48 +09:00
Takeshi KOMIYA
dd00bade70 Merge branch '4.x' 2021-07-12 02:15:45 +09:00
Juan Luis Cano Rodríguez
8531f20eb7 Fix link to NumPy Docstring Standard 2021-07-08 22:34:25 +02:00
Juan Luis Cano Rodríguez
b9da1577b6 Merge branch '4.x' into new-tutorial-part-ii 2021-07-05 20:12:53 +02:00
Juan Luis Cano Rodríguez
6f9bc6e7e5 Use "builtin" for extensions label as it is done for themes 2021-07-05 09:32:10 +02:00
Takeshi KOMIYA
0ee0d8df00
Merge pull request #9399 from tk0miya/napoleon_preprocess_types 
doc: Fix the default value of napoleon_preprocess_types is True
 2021-07-04 11:26:43 +09:00
Takeshi KOMIYA
f6b3f36e23 doc: Fix the default value of napoleon_preprocess_types is True 2021-07-03 17:41:57 +09:00
Louis-Justin TALLOT
a52ccdbfc7 Fix quotes in docstring in ext.napoleon 2021-06-30 19:40:35 +02:00
Juan Luis Cano Rodríguez
1e49218993 Add tutorial section about extensions and themes 2021-06-17 00:21:42 +02:00
Takeshi KOMIYA
e0500f7354 doc: Fix docslint misunderstanding scope of code-blocks 2021-06-06 13:24:06 +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
b6c2edb5ca
doc: Upgraded mathjax documentation link to HTTPS 2021-05-17 20:39:14 +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
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
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
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
0b0414ea17
Update "versionadded" in doc/usage/extensions/autodoc.rst 2021-05-12 00:04:43 +09:00
Ashley Whetter
28d3f8136e autodoc.typehints can accurately represent overloads 2021-05-08 21:34:25 -07: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
Matthias Geier
7b9cc0563d Add documentation for mathjax2_config and mathjax3_config 2021-04-24 10:50:37 +02:00
Takeshi KOMIYA
668bc9eec9 Merge branch '4.0.x' into 4.x 2021-04-19 01:08:54 +09:00
Harmon
5af55008b3
doc: Fix grammar in documentation for autodoc_typehints 2021-04-14 16:41:25 -05: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
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
54886fd256 Close #7549: autosummary: Enable autosummary_generate by default 2021-03-10 01:35:49 +09:00
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
jfbu
87fa272763 Merge branch '3.x' into merge_3.x_into_master 
Resolved Conflicts:
	sphinx/texinputs/sphinxpackagefootnote.sty
 2021-02-04 16:31:45 +01:00
pbudzyns
270921d73a Merge remote-tracking branch 'upstream/3.x' into exclude-members-fix 2021-02-01 10:46:44 +01:00
pbudzyns
35adeeff41 update docs 2021-02-01 10:28:01 +01:00
Takeshi KOMIYA
c9480f9943 Merge branch '3.x' 2021-01-28 00:56:46 +09:00
Takeshi KOMIYA
34417831c5 doc: Add hyperlinks to classifiers for sphinx extensions and themes 2021-01-24 16:45:50 +09:00
Takeshi KOMIYA
0ad32905bf Merge branch '3.x' 2021-01-24 16:39:43 +09:00
Takeshi KOMIYA
51d500833e Merge branch '3.x' into 7774_remove_develop.rst 2021-01-24 16:34:47 +09:00
Steve Piercy
cef669cb0f Update the link to the new sphinx-contrib organization 
This should be backported to at least 3.x, too.
 2021-01-23 17:28:35 +09:00
Steve Piercy
bd63ae9950
Update the link to the new sphinx-contrib organization 
This should be backported to at least 3.x, too.
 2021-01-23 00:08:57 -08:00
Takeshi KOMIYA
5ce72f465b Merge branch '3.x' 2021-01-22 22:52:32 +09:00