summaryrefslogtreecommitdiff
path: root/doc/usage
Commit message (Collapse)AuthorAgeFilesLines
* 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.
* Merge pull request #9628 from ↵Takeshi KOMIYA2021-11-101-0/+6
|\ | | | | | | | | tk0miya/9623_suppress_warnings_for_excluded_document_in_toctree Close #9623: Allow to suppress warnings on excluded document found in toctree
| * Merge branch '4.x' into 9623_suppress_warnings_for_excluded_document_in_toctreeTakeshi KOMIYA2021-11-108-17/+126
| |\
| * | Fix #9623: Separate warning type 'toc.not_readable' to 'toc.excluded'Takeshi KOMIYA2021-11-101-0/+5
| | |
| * | Close #9623: Allow to suppress warnings on excluded document found in toctreeTakeshi KOMIYA2021-09-121-0/+1
| | |
* | | Close #9618: i18n: Add gettext_allow_fuzzy_translationsTakeshi KOMIYA2021-11-101-0/+7
| |/ |/|
* | Document responsiveness of themesMartin Fischer2021-11-031-0/+4
| |
* | 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
* | Update Chocolatey Install LinkDrew Mares2021-10-271-1/+1
| | | | | | The install URL returned a 404 but now it is updated to the new location
* | Fix linkcheck_auth link to Requests authenticationFrançois Freitag2021-10-251-4/+2
| | | | | | | | | | | | | | The link was directing to https://www.sphinx-doc.org/en/master/usage/requests-auth>. Prefer using the intersphinx module to generate the link, it’s more robust than directly linking to the page.
* | 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 #9679 from latosha-maltba/doc/directive-indentTakeshi KOMIYA2021-10-091-1/+21
|\ \ | | | | | | Document indent behaviour for directives
| * | Document indent behaviour for directivesLatosha Maltba2021-09-271-1/+21
| |/ | | | | | | | | | | Mention how the indent of the contents for directives is chosen and what the effect on directives which are sensitive to whitespace is, e.g. code-block.
* | Merge pull request #9534 from astrojuanlu/new-tutorial-describing-codeTakeshi KOMIYA2021-10-092-0/+2
|\ \ | | | | | | New Sphinx tutorial, part III
| * | Add section on autosummaryJuan Luis Cano Rodríguez2021-08-121-0/+1
| | |
| * | Add tutorial section on documenting Python objectsJuan Luis Cano Rodríguez2021-08-121-0/+1
| | |
* | | Typo fixesJakob Lykke Andersen2021-10-011-2/+2
| | |
* | | C++, add retval info field to cpp:functionJakob Lykke Andersen2021-10-011-5/+14
| | |
* | | C, update documentation for info-fieldsJakob Lykke Andersen2021-10-011-0/+43
| | |
* | | doc: update descriptionGhassan Maslamani2021-09-301-3/+3
| | | | | | | | | | | | Update description about how `conf.py` is loaded/executed
* | | 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 #9594 from hkuno/pr/no_empty_desc_4.xTakeshi KOMIYA2021-09-111-0/+2
|\ \ | | | | | | let user skip printing command description
| * | Omit NAME section if blank descriptionHarumi Kuno2021-09-051-0/+2
| | | | | | | | | | | | | | | | | | | | | | | | Also, update man page for configuration to document that if a blank description is entered, the "NAME" section is an empty string. Signed-off-by: Harumi Kuno <harumi.kuno@hpe.com>
* | | Merge pull request #9616 from jdufresne/fix-urlTakeshi KOMIYA2021-09-112-8/+8
|\ \ \ | | | | | | | | 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-062-8/+8
| |/ / | | | | | | | | | | | | | | | 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
|/ /
* | Merge pull request #9545 from aaugustin/4.xTakeshi KOMIYA2021-08-141-5/+5
|\ \ | | | | | | Update link to OpenSearch.
| * | Update link to OpenSearch.Aymeric Augustin2021-08-141-5/+5
| |/ | | | | | | | | Amazon repurposed the opensearch.org domain. It is now hosting their ElasticSearch fork.
* | fix typo in numfig_format default valueKevin Anderson2021-08-131-1/+1
|/
* Fix typoJohn Cole2021-08-041-1/+1
|
* doc: Add document for autoproperty directive (refs: #9486)Takeshi KOMIYA2021-07-231-0/+3
|
* Cloase #9445: :py:property: directive now supports :classmethod: optionTakeshi KOMIYA2021-07-171-0/+7
| | | | | Since python 3.9, `classmethod` starts to support creating a "class property". This allows to describe it.
* Fix typoEisuke Kawashima2021-07-081-1/+1
|
* Merge branch '4.x' into 6525_linkcheck_warn_redirectsTakeshi KOMIYA2021-07-0712-38/+85
|\
| * Merge pull request #9340 from ocket8888/patch-1Takeshi KOMIYA2021-07-071-1/+1
| |\ | | | | | | Update example to use recommended usage
| | * Update example to use recommended usageocket88882021-06-141-1/+1
| | |
| * | Merge branch '4.x' into new-tutorial-part-iiJuan Luis Cano Rodríguez2021-07-052-3/+11
| |\ \
| | * \ 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
| | | | |
| | * | | Merge pull request #9392 from LouisJustinTALLOT/patch-1Takeshi KOMIYA2021-07-031-2/+2
| | |\ \ \ | | | |/ / | | |/| | Fix quotes in docstring in ext.napoleon
| | | * | Fix quotes in docstring in ext.napoleonLouis-Justin TALLOT2021-06-301-2/+2
| | | |/
| | * | Merge branch '4.0.x' into 4.xTakeshi KOMIYA2021-06-301-0/+8
| | |\ \ | | | |/ | | |/|
| | | * C, keyword changesJakob Lykke Andersen2021-06-171-0/+8
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | - Add new keywords from C23. - Add c_extra_keywords as confval. - Move macro names from keywords to c_extra_keywords. Fixes sphinx-doc/sphinx#9354
| | | * manpage: Stop creating a section directory on build manpage by defaultTakeshi KOMIYA2021-05-161-0/+4
| | | |
| * | | Use "builtin" for extensions label as it is done for themesJuan Luis Cano Rodríguez2021-07-051-1/+1
| | | |
View Lorry Controller Status