summaryrefslogtreecommitdiff
path: root/doc/usage/extensions
Commit message (Collapse)AuthorAgeFilesLines
...
| * | | | | Merge branch '4.x'Takeshi KOMIYA2021-10-092-2/+7
| |\ \ \ \ \
| * \ \ \ \ \ Merge branch '4.x'Takeshi KOMIYA2021-09-121-6/+6
| |\ \ \ \ \ \
| * \ \ \ \ \ \ Merge branch '4.x'Takeshi KOMIYA2021-09-111-3/+3
| |\ \ \ \ \ \ \
| * | | | | | | | Fix typo in autodoc documentationNicolas Delon2021-08-251-1/+1
| | | | | | | | |
| * | | | | | | | Merge branch '4.x'Takeshi KOMIYA2021-07-301-0/+3
| |\ \ \ \ \ \ \ \
| * \ \ \ \ \ \ \ \ Merge branch '4.x'Takeshi KOMIYA2021-07-121-0/+4
| |\ \ \ \ \ \ \ \ \
| * | | | | | | | | | Fix link to NumPy Docstring StandardJuan Luis Cano Rodríguez2021-07-082-3/+3
| | | | | | | | | | |
* | | | | | | | | | | docs: add new option to documentationgschwaer2021-11-291-0/+8
| |_|_|_|_|_|_|_|_|/ |/| | | | | | | | |
* | | | | | | | | | Merge pull request #9831 from Yoshanuikabundi/autosummary___all__Takeshi KOMIYA2021-11-261-0/+19
|\ \ \ \ \ \ \ \ \ \ | |_|_|_|_|_|_|_|_|/ |/| | | | | | | | | Allow autosummary to respect __all__
| * | | | | | | | | Corrections from review by tk0miyaJosh Mitchell2021-11-151-7/+7
| | | | | | | | | |
| * | | | | | | | | #2021: Allow autosummary to respect __all__Josh Mitchell2021-11-151-0/+19
| | |_|_|_|_|_|_|/ | |/| | | | | | |
* | | | | | | | | Fix #9864: mathjax: Failed to render equations via MathJax v2Takeshi KOMIYA2021-11-211-0/+5
|/ / / / / / / / | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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.
* | | | | | | | rename intersphinx_disabled_{refs -> reftypes}Jakob Lykke Andersen2021-10-311-6/+7
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | And change format for domains to {name}:*
* | | | | | | | intersphinx_disabled_refs, doc default valueJakob Lykke Andersen2021-10-311-0/+2
| | | | | | | |
* | | | | | | | intersphinx_disabled_refs, rename 'all' to '*'Jakob Lykke Andersen2021-10-311-2/+2
| | | | | | | |
* | | | | | | | Generalize to disable specific refs as well.Jakob Lykke Andersen2021-10-311-12/+19
| | | | | | | |
* | | | | | | | Fix typoJakob Lykke Andersen2021-10-311-1/+1
| | | | | | | |
* | | | | | | | Add intersphinx_disabled_domainsJakob Lykke Andersen2021-10-311-0/+19
| |_|_|_|_|_|/ |/| | | | | | | | | | | | | | | | | | | | | | | | | | | Fixes sphinx-doc/sphinx#2068 Replaces sphinx-doc/sphinx#8981
* | | | | | | Add missing space in intersphinx docGabe R2021-10-191-1/+1
| |_|_|_|_|/ |/| | | | | | | | | | | 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.
* | | | | | Merge pull request #9534 from astrojuanlu/new-tutorial-describing-codeTakeshi KOMIYA2021-10-091-0/+1
|\ \ \ \ \ \ | | | | | | | | | | | | | | New Sphinx tutorial, part III
| * | | | | | Add section on autosummaryJuan Luis Cano Rodríguez2021-08-121-0/+1
| | |_|/ / / | |/| | | |
* | | | | | 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
|/ /