summaryrefslogtreecommitdiff
path: root/doc/usage/extensions
Commit message (Collapse)AuthorAgeFilesLines
...
* | fixup! sphinx.ext.extlinks: Clarify escaping of ``%``Merry Bass2021-04-111-2/+2
| |
* | sphinx.ext.extlinks: Clarify escaping of ``%``Merry Bass2021-04-111-2/+7
| | | | | | | | | | We use Pythons %-formatting, so literal ``%`` must be escaped as ``%%``. Clarify this behaviour for the caption and base URL strings.
* | sphinx.ext.extlinks: Allow ``%s`` in link caption stringMerry Bass2021-04-111-9/+8
|/ | | | | | | | | | | | | | | | 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.
* Merge pull request #8841 from AWhetter/autodoc_signatures_without_backslashTakeshi KOMIYA2021-04-041-3/+7
|\ | | | | Overloaded function signatures do not require a separating backslash
| * Overloaded function signatures do not require a separating backslashAshley Whetter2021-03-271-3/+7
| |
* | Add autodoc_typehint_undoc optionMatt Wozniski2021-03-271-0/+13
|/ | | | | | | | | | | | | | 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.
* Close #7549: autosummary: Enable autosummary_generate by defaultTakeshi KOMIYA2021-03-101-6/+12
|
* doc: Fix indentationTakeshi KOMIYA2021-03-061-3/+3
|
* Merge pull request #8965 from tk0miya/refactor_docTakeshi KOMIYA2021-03-061-52/+75
|\ | | | | doc: Update document for autodoc
| * doc: Update document for autodoc :special-members: optionTakeshi KOMIYA2021-03-061-15/+22
| |
| * doc: Update document for autodoc :private-members: optionTakeshi KOMIYA2021-03-061-18/+21
| |
| * doc: Update document for autodoc :undoc-members: optionTakeshi KOMIYA2021-03-061-7/+10
| |
| * doc: Update document for autodoc :members: optionTakeshi KOMIYA2021-03-061-12/+22
| |
* | Fix #759: autodoc: Add sphinx.ext.autodoc.preserve_defaults extensionTakeshi KOMIYA2021-03-061-0/+10
|/ | | | | | | | 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.
* Merge branch '3.x' into merge_3.x_into_masterjfbu2021-02-041-0/+11
|\ | | | | | | | | Resolved Conflicts: sphinx/texinputs/sphinxpackagefootnote.sty
| * Merge remote-tracking branch 'upstream/3.x' into exclude-members-fixpbudzyns2021-02-016-24/+133
| |\
| * | update docspbudzyns2021-02-011-0/+11
| | |
* | | Merge branch '3.x'Takeshi KOMIYA2021-01-281-4/+5
|\ \ \ | | |/ | |/|
| * | doc: Add hyperlinks to classifiers for sphinx extensions and themesTakeshi KOMIYA2021-01-241-4/+5
| | |
* | | Merge branch '3.x'Takeshi KOMIYA2021-01-241-16/+13
|\ \ \ | |/ /
| * | Merge branch '3.x' into 7774_remove_develop.rstTakeshi KOMIYA2021-01-247-16/+248
| |\ \
| | * | Update the link to the new sphinx-contrib organizationSteve Piercy2021-01-231-1/+1
| | | | | | | | | | | | This should be backported to at least 3.x, too.
| * | | docs: Add information about Sphinx trove classifiersStephen Finucane2020-06-031-1/+5
| | | | | | | | | | | | | | | | Signed-off-by: Stephen Finucane <stephen@that.guru>
| * | | docs: Update reference to sphinx-contrib organizationStephen Finucane2020-06-021-16/+9
| | | | | | | | | | | | | | | | | | | | | | | | | | | | This is now well established on GitHub and the Bitbucket organization is no longer maintained. Update the documentation to indicate this. Signed-off-by: Stephen Finucane <stephen@that.guru>
* | | | Update the link to the new sphinx-contrib organizationSteve Piercy2021-01-231-1/+1
| | | | | | | | | | | | This should be backported to at least 3.x, too.
* | | | Merge branch '3.x'Takeshi KOMIYA2021-01-221-1/+25
|\ \ \ \ | | |/ / | |/| |
| * | | Merge pull request #8658 from SolidifiedRay/feature-custom-sectionTakeshi KOMIYA2021-01-191-1/+25
| |\ \ \ | | | | | | | | | | Close #8573: napoleon: Add more custom section styles
| | * | | Close #8573: napoleon: Add more custom section stylesSolidifiedRay2021-01-181-1/+25
| | | | |
* | | | | Merge branch '3.x'Takeshi KOMIYA2021-01-161-3/+3
|\ \ \ \ \ | |/ / / /
| * | | | doc: Fix highlight languageTakeshi KOMIYA2021-01-101-3/+3
| |/ / /
* | | | Merge branch '3.x'Takeshi KOMIYA2021-01-031-1/+1
|\ \ \ \ | |/ / /
| * | | DOC: `modules` are only available when `recursive` is onHong Xu2021-01-011-1/+1
| | | | | | | | | | | | | | | | | | | | See https://github.com/sphinx-doc/sphinx/blob/7ecf6b88aa5ddaed552527d2ef60f1bd35e98ddc/sphinx/ext/autosummary/generate.py#L314-L315
* | | | Merge branch '3.x'Takeshi KOMIYA2020-12-291-1/+11
|\ \ \ \ | |/ / /
| * | | Update autodoc.rstHong Xu2020-12-271-1/+1
| | | |
| * | | Doc: Correct type: "TypeAlias" -> "AliasType"Hong Xu2020-12-271-1/+1
| | | |
| * | | Close #8022: autodoc: Allow to hide the value of the variables via metadataTakeshi KOMIYA2020-12-271-0/+10
| | | | | | | | | | | | | | | | | | | | | | | | autodata and autoattribute directives does not show right-hand value of the variable if its docstring contains ``:meta hide-value:`` in info-field-list.
* | | | Merge branch '3.x'Takeshi KOMIYA2020-12-143-4/+69
|\ \ \ \ | |/ / /
| * | | Describe the intersphinx mapping a bit moreNed Batchelder2020-12-131-3/+14
| | | |
| * | | refactored code and tests, prepared for numpy featureQuentin Soubeyran2020-11-252-6/+8
| | | |
| * | | added napoleon_google_attr_annotations option to use PEP 526 on google styleQuentin Soubeyran2020-11-252-1/+53
| | | |
* | | | Merge branch '3.x'Takeshi KOMIYA2020-11-211-0/+12
|\ \ \ \ | |/ / /
| * | | Rename :novalue: option to :no-value: optionTakeshi KOMIYA2020-11-151-5/+5
| | | | | | | | | | | | | | | | | | | | According to the existing options of autodoc directives, `:novalue:` option is now renamed to `:no-value:` option.
| * | | autodoc: document :novalue: optionMarlon James2020-11-151-0/+12
| | |/ | |/|
* | | Merge branch '3.x' into masterTakeshi KOMIYA2020-10-042-1/+39
|\ \ \ | |/ /
| * | Strip trailing whitespaces and normalize line endingsFrançois Freitag2020-10-031-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | 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.
| * | Close #6518: autodoc: Add autodoc_type_aliasesTakeshi KOMIYA2020-10-031-0/+38
| | | | | | | | | | | | | | | autodoc_type_aliases allows to keep user defined type alises not evaluated in the generated document.
* | | Merge branch '3.x' into masterTakeshi KOMIYA2020-10-031-1/+1
|\ \ \ | |/ /
| * | Fix typo: anchestor -> ancestor.Bradley Dice2020-09-201-1/+1
| | |
* | | sphinx.ext.autodoc: fix typo in docsAdam J. Stewart2020-08-111-1/+1
| | |
* | | Merge branch '3.x'Takeshi KOMIYA2020-08-082-4/+32
|\ \ \ | |/ /
View Lorry Controller Status