summaryrefslogtreecommitdiff
path: root/doc/usage/extensions
Commit message (Collapse)AuthorAgeFilesLines
* Close #9664: autodoc: autodoc-process-bases supports reST snippetTakeshi KOMIYA2021-09-231-2/+6
| | | | | | 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.
* Merge pull request #9616 from jdufresne/fix-urlTakeshi KOMIYA2021-09-111-6/+6
|\ | | | | Update Sphinx url: s|https?://sphinx-doc\.org/|https://www.sphinx-doc.org/|g
| * Update Sphinx url: s|https?://sphinx-doc\.org/|https://www.sphinx-doc.org/|gJon Dufresne2021-09-061-6/+6
| | | | | | | | | | | | 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.
* | Fix typos discovered by codespellChristian Clauss2021-09-081-3/+3
|/
* doc: Add document for autoproperty directive (refs: #9486)Takeshi KOMIYA2021-07-231-0/+3
|
* Merge branch '4.x' into new-tutorial-part-iiJuan Luis Cano Rodríguez2021-07-051-3/+3
|\
| * Merge pull request #9399 from tk0miya/napoleon_preprocess_typesTakeshi KOMIYA2021-07-041-1/+1
| |\ | | | | | | doc: Fix the default value of napoleon_preprocess_types is True
| | * doc: Fix the default value of napoleon_preprocess_types is TrueTakeshi KOMIYA2021-07-031-1/+1
| | |
| * | Fix quotes in docstring in ext.napoleonLouis-Justin TALLOT2021-06-301-2/+2
| |/
* | Use "builtin" for extensions label as it is done for themesJuan Luis Cano Rodríguez2021-07-051-1/+1
| |
* | Add tutorial section about extensions and themesJuan Luis Cano Rodríguez2021-06-171-0/+4
|/
* doc: Fix docslint misunderstanding scope of code-blocksTakeshi KOMIYA2021-06-061-8/+3
|
* Merge pull request #9239 from igo95862/https-linksTakeshi KOMIYA2021-05-194-4/+4
|\ | | | | Upgrade URLs to use HTTPS
| * doc: Upgraded mathjax documentation link to HTTPSigo958622021-05-171-1/+1
| |
| * doc: Moved Jinja links to new home page and HTTPSigo958622021-05-171-1/+1
| | | | | | | | | | Seems like Jinja is no longer pocoo project but palletsprojects.com
| * doc: Upgraded some of sphinx-doc.org links to HTTPSigo958622021-05-161-1/+1
| | | | | | | | | | Seems like that link is used in some tests and code so upgrading it outside documentation might break something
| * doc: Upgrade docutils.sourceforge.io links to HTTPSigo958622021-05-161-1/+1
| | | | | | | | | | Also change any docutils.sourceforge.net link to io top level domain.
* | Merge branch '4.x' into 3014_autodoc-process-basesTakeshi KOMIYA2021-05-171-0/+14
|\ \ | |/
| * Close #4257: autodoc: Add autodoc_class_signatureTakeshi KOMIYA2021-05-161-0/+14
| | | | | | | | | | Add `autodoc_class_signature` to separate the class entry and the definition of `__init__()` method.
* | Close #3014: autodoc: Add autodoc-process-basesTakeshi KOMIYA2021-05-161-0/+15
|/ | | | | | 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.
* Update "versionadded" in doc/usage/extensions/autodoc.rstTakeshi KOMIYA2021-05-121-1/+1
|
* autodoc.typehints can accurately represent overloadsAshley Whetter2021-05-081-2/+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 documentation for mathjax2_config and mathjax3_configMatthias Geier2021-04-241-7/+42
|
* 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
| | |
* | | 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
| |
* | 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
| |\ \
View Lorry Controller Status