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
17,462 Commits 2 Branches 219 Tags 163 MiB
50f5280603
Commit Graph

201 Commits

Author SHA1 Message Date
Matthias Geier
778faffecc Add documentation for mathjax2_config and mathjax3_config 2021-04-24 18:30:44 +09:00
Harmon
31718d78b4 doc: Fix grammar in documentation for autodoc_typehints 2021-04-17 17:46:31 +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
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
Takeshi KOMIYA
ca0677086d
Merge pull request #8658 from SolidifiedRay/feature-custom-section 
Close #8573: napoleon: Add more custom section styles
 2021-01-19 21:13:13 +09:00
SolidifiedRay
7ad85cd1e0 Close #8573: napoleon: Add more custom section styles 2021-01-18 11:43:40 -08:00
Takeshi KOMIYA
30f8640bab Merge branch '3.x' 2021-01-16 21:51:46 +09:00
Takeshi KOMIYA
f433581b04 doc: Fix highlight language 2021-01-10 22:22:30 +09:00
Takeshi KOMIYA
a9c7dd7037 Merge branch '3.x' 2021-01-03 00:20:27 +09:00
Hong Xu
1f020196a7 DOC: modules are only available when recursive is on 
See
7ecf6b88aa/sphinx/ext/autosummary/generate.py (L314-L315)
 2021-01-01 11:12:58 -08:00
Takeshi KOMIYA
a122397b4b Merge branch '3.x' 2020-12-29 18:37:45 +09:00
Hong Xu
d9ca895dbb
Update autodoc.rst 2020-12-27 21:24:19 -08:00
Hong Xu
6927130ff1
Doc: Correct type: "TypeAlias" -> "AliasType" 2020-12-27 21:23:31 -08:00
Takeshi KOMIYA
9e9e486e65 Close #8022: autodoc: Allow to hide the value of the variables via metadata 
autodata and autoattribute directives does not show right-hand value of
the variable if its docstring contains ``:meta hide-value:`` in
info-field-list.
 2020-12-27 12:46:03 +09:00
Takeshi KOMIYA
2c98e909bf Merge branch '3.x' 2020-12-14 02:02:29 +09:00
Ned Batchelder
bac6ab8d0c Describe the intersphinx mapping a bit more 2020-12-13 08:04:55 -05:00
Quentin Soubeyran
ec30f77712 refactored code and tests, prepared for numpy feature 2020-11-25 08:45:25 +01:00
Quentin Soubeyran
f268665292 added napoleon_google_attr_annotations option to use PEP 526 on google style 2020-11-25 08:45:25 +01:00
Takeshi KOMIYA
3a4ae2092a Merge branch '3.x' 2020-11-21 01:01:36 +09:00
Takeshi KOMIYA
5676fdeb4e Rename :novalue: option to :no-value: option 
According to the existing options of autodoc directives, `:novalue:`
option is now renamed to `:no-value:` option.
 2020-11-15 14:20:30 +09:00
Marlon James
6082ce67a4 autodoc: document :novalue: option 2020-11-15 14:19:33 +09:00
Takeshi KOMIYA
598b85da75 Merge branch '3.x' into master 2020-10-04 22:41:44 +09:00
François Freitag
5166dd194c
Strip trailing whitespaces and normalize line endings 
Trailing whitespace do not have impact on the result, they are just
unused bytes. Most text editors are configured to strip trailing
whitespaces. Remove them all in one go.

Update a handful of files to use the UNIX line ending.
 2020-10-03 13:47:01 +02:00
Takeshi KOMIYA
f2c0dfe7c4 Close #6518: autodoc: Add autodoc_type_aliases 
autodoc_type_aliases allows to keep user defined type alises not
evaluated in the generated document.
 2020-10-03 16:03:35 +09:00
Takeshi KOMIYA
26ea870267 Merge branch '3.x' into master 2020-10-03 13:43:21 +09:00