summaryrefslogtreecommitdiff
path: root/doc/usage
Commit message (Collapse)AuthorAgeFilesLines
...
| * | Update "versionadded" in doc/usage/extensions/autodoc.rstTakeshi KOMIYA2021-05-121-1/+1
| | |
| * | autodoc.typehints can accurately represent overloadsAshley Whetter2021-05-081-2/+14
| | |
* | | doc: Update CHANGES and docs for PR #9176Takeshi KOMIYA2021-05-091-0/+4
|/ /
* | Merge pull request #9131 from RuRo/feature/glob-nitpick-ignoreTakeshi KOMIYA2021-05-051-0/+14
|\ \ | | | | | | Ignore nitpick warnings with regular expressions using `nitpick_ignore_regex`
| * | describe nitpick_ignore_regex in docsruro2021-05-021-0/+14
| | |
* | | Close #8107: autodoc: Add class-doc-from option to autoclass directiveTakeshi KOMIYA2021-05-011-1/+8
| | | | | | | | | | | | | | | | | | 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`.
* | | Add doc and testcase for program directive (refs: #9137)Takeshi KOMIYA2021-04-281-0/+3
| | | | | | | | | | | | | | | | | | 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.
* | | Add documentation for mathjax2_config and mathjax3_configMatthias Geier2021-04-241-7/+42
|/ /
* | Merge branch '4.0.x' into 4.xTakeshi KOMIYA2021-04-201-2/+2
|\ \ | |/
| * doc: Fix typoTakeshi KOMIYA2021-04-201-2/+2
| |
| * doc: Fix grammar in documentation for autodoc_typehintsHarmon2021-04-171-1/+1
| |
* | Merge branch '4.0.x' into 4.xTakeshi KOMIYA2021-04-192-1/+16
|\ \ | |/
| * Merge pull request #9084 from tk0miya/8731_docs_for_napoleon_preprocess_typesTakeshi KOMIYA2021-04-131-1/+12
| |\ | | | | | | doc: Add docs for napoleon_preprocess_types
| | * doc: Add docs for napoleon_preprocess_typesTakeshi KOMIYA2021-04-111-1/+12
| | |
| * | docs: Add versionchanged tag to extlinks (refs: #8898)Takeshi KOMIYA2021-04-111-0/+4
| | |
* | | Recommend MyST-Parser for Markdown usageJuan Luis Cano Rodríguez2021-04-151-19/+13
| | |
* | | doc: Fix grammar in documentation for autodoc_typehintsHarmon2021-04-141-1/+1
|/ /
* | 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
| |
* | Merge branch '3.x'Takeshi KOMIYA2021-04-041-1/+1
|\ \
| * | Fix minor typoAlbert Villanova del Moral2021-03-301-1/+1
| | |
* | | 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.
* | Fix #9008: Fix typoTakeshi KOMIYA2021-03-161-1/+1
| |
* | Merge pull request #7298 from tk0miya/7068_pyproperty_directiveTakeshi KOMIYA2021-03-131-0/+22
|\ \ | | | | | | py domain: Add py:property directive to describe a property (refs: #7068)
| * | py domain: Add py:property directive to describe a property (refs: #7068)Takeshi KOMIYA2021-03-111-0/+22
| | |
* | | Close #7549: autosummary: Enable autosummary_generate by defaultTakeshi KOMIYA2021-03-101-6/+12
|/ /
* | Merge pull request #8970 from naveen521kk/patch-1Takeshi KOMIYA2021-03-071-1/+24
|\ \ | | | | | | Sphinx is available on Chocolatey
| * | lintNaveen M K2021-03-071-2/+3
| | |
| * | Sphinx is available on ChocolateyNaveen M K2021-03-071-1/+23
| |/
* | 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.
* | Fix #7199: py domain: Add a new confval: python_use_unqualified_type_namesTakeshi KOMIYA2021-03-061-0/+11
| | | | | | | | | | | | 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.
* | Close #8326: Rename master_doc to root_docTakeshi KOMIYA2021-02-282-8/+17
| | | | | | | | | | | | To describe the purpose more accurately, the `master_doc` is now renamed to `root_doc`. The old name is still available. But it is recommeneded to use new one from now on.
* | Merge branch '3.x'jfbu2021-02-121-0/+25
|\ \ | |/
| * C++, add noroot option to alias directiveJakob Lykke Andersen2021-02-121-0/+7
| |
| * C, add noroot option to alias directiveJakob Lykke Andersen2021-02-121-0/+7
| |
| * C++, add recursiveness to aliasJakob Lykke Andersen2021-02-121-0/+11
| | | | | | | | Fixes sphinx-doc/sphinx#8213 in the most basic way.
* | Make code block types more visibleHarrissou Sant-anna2021-02-081-4/+9
| |
* | 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-019-40/+260
| |\
| * | update docspbudzyns2021-02-011-0/+11
| | |
* | | Merge branch '3.x' into master_with_merged_3.xjfbu2021-02-021-3/+4
|\ \ \ | | |/ | |/|
View Lorry Controller Status