summaryrefslogtreecommitdiff
path: root/doc/usage
Commit message (Collapse)AuthorAgeFilesLines
...
| * | | Merge commit '799385f5558a888d1a143bf703d06b66d6717fe4'Takeshi KOMIYA2022-02-161-3/+12
| |\ \ \ | | |/ /
| | * | Merge pull request #9337 from marxin/new-shortcutsTakeshi KOMIYA2022-01-311-3/+12
| | |\ \ | | | | | | | | | | Implement new search shortcuts.
| | | * | Implement new shortcuts:Martin Liska2022-01-221-3/+12
| | | |/ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | - "/" for Focus search bar - "ESC" - clear highlighted text Fixes #691. Co-authored-by: Jakob Lykke Andersen <jakobandersen@users.noreply.github.com>
| * | | Merge commit '07110b7557a552ecfe702bdd6a2d2f9685cb1af9'Takeshi KOMIYA2022-02-141-2/+2
| |\ \ \ | | |/ /
| | * | Update autosummary.rstTimo Cornelius Metzger2022-01-271-2/+2
| | |/
| * | Merge commit '2be06309518d9401a42880bb5b4321dfdd1e5e90'Takeshi KOMIYA2022-02-141-0/+7
| |\ \ | | |/
| | * Close #9456: html search: Add a config variable; html_show_search_summaryTakeshi KOMIYA2022-01-171-0/+7
| | | | | | | | | | | | refs: #9494
| * | Merge branch '4.x'Takeshi KOMIYA2022-01-171-23/+57
| |\ \ | | |/
| | * intersphinx role, update docsJakob Lykke Andersen2022-01-161-6/+6
| | |
| | * intersphinx role, documentationJakob Lykke Andersen2022-01-161-23/+57
| | |
| * | Merge branch '4.x'Takeshi KOMIYA2022-01-161-0/+4
| |\ \ | | |/
| | * Merge branch '4.x' into HEADTakeshi KOMIYA2022-01-1512-32/+213
| | |\
| | | * In translated docs, sort glossaries by translated termsJean Abou Samra2022-01-121-0/+3
| | | | | | | | | | | | | | | | | | | | | | | | | | | | This is done by moving the sorting from the glossary directive to a transform operating after the i18n transform. Closes #9827
| | * | Update :dedent: exampleLatosha Maltba2021-09-231-0/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | The presence or absence of the ``:dedent: 4`` option in the example .. code-block:: ruby :dedent: 4 some ruby code makes no difference for the output due to how ReST handles whitespace. If it is present, then ReST indent is 3 and the 4 spaces of the code are stripped by the :dedent: option. If the dedent option is missing, then the ReST indent is 7 and all whitespace is stripped again. Add a dummy option to fixate the ReST indent to 3, so adding and removing of the option in the example has an effect on the output.
| * | | Merge branch 'master' into 9595_deprecate_setuptools_integrationTakeshi KOMIYA2022-01-021-2/+5
| |\ \ \
| | * | | autodoc: The default of autodoc_typehints_format becomes to 'smart'Takeshi KOMIYA2022-01-021-2/+5
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | The default value of autodoc_typehints_format configuration is changed to `'smart'`. It will suppress the leading module names of typehints (ex. `io.StringIO` -> `StringIO`). refs: #9075
| * | | | Close #9595: Deprecate setuptools integrationTakeshi KOMIYA2022-01-011-0/+4
| |/ / /
| * | | Merge branch '4.x'Takeshi KOMIYA2022-01-011-3/+8
| |\ \ \ | | | |/ | | |/|
| | * | autodoc: Rename autodoc_unqualified_typehints to autodoc_typehints_format ↵Takeshi KOMIYA2021-12-241-3/+8
| | | | | | | | | | | | | | | | (refs: #9931)
| * | | Merge branch '4.x'Takeshi KOMIYA2021-12-241-2/+2
| |\ \ \ | | |/ /
| | * | doc: Update explanation of autodoc_unqualified_typehints (ref: #9931)Takeshi KOMIYA2021-12-181-2/+2
| | | |
| * | | Merge branch '4.x'Takeshi KOMIYA2021-12-174-13/+13
| |\ \ \ | | |/ /
| | * | doc: Use "console" for the highlight language of console outputTakeshi KOMIYA2021-12-134-13/+13
| | | | | | | | | | | | | | | | | | | | Using "console" language is better for the console example (including command-line prompt)
| * | | Merge branch '4.x'Takeshi KOMIYA2021-12-112-0/+14
| |\ \ \ | | |/ /
| | * | Merge pull request #9931 from tk0miya/9075_autodoc_unqualified_typehintsTakeshi KOMIYA2021-12-111-0/+7
| | |\ \ | | | | | | | | | | Close #9075: autodoc: Add a config variable autodoc_unqualified_typehints
| | | * | Close #9075: autodoc: Add a config variable autodoc_unqualified_typehintsTakeshi KOMIYA2021-12-031-0/+7
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | If autodoc_unqualified_typehints feature enabled, autodoc suppresses the leading module names of typehints of function signatures (ex. `io.StringIO` -> `StringIO`)
| | * | | Merge branch '4.x' into texinfo-add-texinfo_emit_document_referencesTakeshi KOMIYA2021-12-113-2/+39
| | |\ \ \
| | * | | | texinfo: simplify reference emission.Martin Liska2021-11-121-0/+7
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | The commit adds a new config value 'texinfo_emit_document_references' that blocks the emission of inline references and make it better readable with legacy stand-alone reader ``info``. Before the change we emit: Default option value for @ref{e,,-Wshift-overflow3}. while with texinfo_emit_document_references == True: Default option value for -Wshift-overflow3. It addresses limitations mentioned in Sphinx' FAQ: https://www.sphinx-doc.org/en/master/faq.html#texinfo-info
| * | | | | Merge branch '4.x'Takeshi KOMIYA2021-12-101-0/+13
| |\ \ \ \ \ | | | |/ / / | | |/| | |
| | * | | | linkcheck: Exclude links from matched documentsChristian Roth2021-12-081-0/+13
| | | |/ / | | |/| |
| * | | | Fixes statement typoAgbonze Osazuwa2021-12-041-1/+1
| | | | |
| * | | | Merge branch '4.x'Takeshi KOMIYA2021-11-281-0/+19
| |\ \ \ \ | | |/ / /
| * | | | Merge branch '4.x'Takeshi KOMIYA2021-11-231-0/+5
| |\ \ \ \
| * \ \ \ \ Merge branch '4.x'Takeshi KOMIYA2021-11-181-2/+2
| |\ \ \ \ \
| * \ \ \ \ \ Merge branch '4.x'Takeshi KOMIYA2021-11-111-0/+13
| |\ \ \ \ \ \ | | | |_|_|/ / | | |/| | | |
| * | | | | | Merge branch '4.x'Takeshi KOMIYA2021-11-071-0/+4
| |\ \ \ \ \ \
| * \ \ \ \ \ \ Merge pull request #9806 from jenshaase/patch-1Takeshi KOMIYA2021-11-071-3/+3
| |\ \ \ \ \ \ \ | | | | | | | | | | | | | | | | | | Fixed docker links in the installation.rst
| | * | | | | | | Fixed docker links in the installation.rstJens Haase2021-11-011-3/+3
| | | | | | | | | | | | | | | | | | | | | | | | | | | The old links, linked to a login page of docker hub. The new links link to the public pages.
| * | | | | | | | Change default value of intersphinx_disabled_reftypesJakob Lykke Andersen2021-10-311-1/+5
| |/ / / / / / / | | | | | | | | | | | | | | | | | | | | | | | | See discussion in sphinx-doc/sphinx#9459
| * | | | | | | Merge branch '4.x'Jakob Lykke Andersen2021-10-311-0/+29
| |\ \ \ \ \ \ \
| * \ \ \ \ \ \ \ Merge branch '4.x'Takeshi KOMIYA2021-10-282-5/+3
| |\ \ \ \ \ \ \ \
| * \ \ \ \ \ \ \ \ Merge branch '4.x'Takeshi KOMIYA2021-10-232-2/+22
| |\ \ \ \ \ \ \ \ \
| * \ \ \ \ \ \ \ \ \ Merge branch '4.x'Takeshi KOMIYA2021-10-094-10/+68
| |\ \ \ \ \ \ \ \ \ \
| * \ \ \ \ \ \ \ \ \ \ Merge branch '4.x'Takeshi KOMIYA2021-09-122-8/+10
| |\ \ \ \ \ \ \ \ \ \ \ | | | |_|_|_|_|_|_|_|_|/ | | |/| | | | | | | | |
| * | | | | | | | | | | 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-08-211-6/+6
| |\ \ \ \ \ \ \ \ \ \ \ \
| * \ \ \ \ \ \ \ \ \ \ \ \ Merge branch '4.x'Takeshi KOMIYA2021-08-131-1/+1
| |\ \ \ \ \ \ \ \ \ \ \ \ \
| * \ \ \ \ \ \ \ \ \ \ \ \ \ Merge branch '4.x'Takeshi KOMIYA2021-07-301-0/+3
| |\ \ \ \ \ \ \ \ \ \ \ \ \ \
| * | | | | | | | | | | | | | | :manpage: is a role, not a directive. [ci skip]Darren Ng2021-07-261-1/+1
| | | | | | | | | | | | | | | |