summaryrefslogtreecommitdiff
path: root/doc/usage/extensions
Commit message (Collapse)AuthorAgeFilesLines
* Enable 'nit-picky mode' for Sphinx's documentationAdam Turner2023-04-062-4/+9
| | | | | Fix several reference errors throughout the documentation and set ``nitpick_ignore`` in ``doc/conf.py``.
* Update doc and CHANGES for PR #11281Jean-François B2023-04-031-0/+25
|
* Docs: Add a link to sphinx-extensions (#11260)Benjamin Balder Bach2023-03-231-2/+4
|
* Deprecate legacy ``intersphinx_mapping`` format (#11247)Adam Turner2023-03-171-11/+23
| | | This format was made obsolete in Sphinx 1.0, but never formally deprecated.
* Documentation reshuffle (#11112)Adam Turner2023-01-081-0/+1
|
* Document autosummary template variable "objtype" (#11044)Tim Hoffmann2023-01-021-0/+6
|
* Run the ``pyupgrade`` toolAdam Turner2022-10-172-4/+2
|
* Add debug logging to `autosectionlabel` (#10881)Martin Patz2022-10-041-0/+9
| | | Co-authored-by: Martin Patz <martin@recogni.com>
* imgmath: Allow embedding images in HTML as base64 (#10816)Julien Schueller2022-09-231-0/+6
| | | Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
* Do not apply epigraph style to all block quotesAdam Turner2022-09-122-37/+37
| | | | | | | Correct indentation where appropriate for stanzas that should not be rendered as `<blockquote>` HTML elements. Closes GH-10686
* Remove extra line (#10749)Abdur-Rahmaan Janhangeer2022-08-041-2/+0
| | | Co-authored-by: Jean-François B. <2589111+jfbu@users.noreply.github.com>
* Fix indentation of .. version{changed,added}.marxin2022-07-191-2/+2
|
* Remove traces of Python 2 and 3.5 (#10560)Adam Turner2022-06-161-2/+2
|
* Replace doclinter with sphinx-lint (#10389)Julien Palard2022-06-162-3/+3
| | | Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
* Merge pull request #10386 from mxd4/10384-comment-img-magickTakeshi KOMIYA2022-05-221-7/+10
|\ | | | | Add comments on ImageMagick requirement
| * #10384 - Grammarmxd42022-05-021-3/+3
| |
| * #10384 - Fix flake8mxd42022-05-021-1/+1
| |
| * #10384 - Explicit warning and improve doc claritymxd42022-05-021-7/+9
| |
| * #10384 - Changes after suggestionsmxd42022-05-021-3/+3
| |
| * #10384 - Add line break to fix docslintmxd42022-05-021-1/+2
| |
| * #10384 - Add comment on ImageMagick requirementmxd42022-05-021-1/+1
| |
* | sphinx.ext.napoleon docs: fix Google style linkStefaan Lippens2022-04-251-2/+2
|/
* Merge branch '5.x' into autodoc_force_undocumented_rtypeTakeshi KOMIYA2022-04-031-0/+8
|\
| * Close #8417: autodoc: :inherited-members: option now takes multiple classesTakeshi KOMIYA2022-04-031-0/+8
| | | | | | | | | | It allows to suppress inherited members of several classes on the module at once by specifying the option to `automodule` directive
* | autodoc_typehints_description_target: Rename ↵Takeshi KOMIYA2022-04-031-5/+5
| | | | | | | | returnvalue_and_documented_params to documented_params
* | Merge branch '5.x' into autodoc_force_undocumented_rtypeTakeshi KOMIYA2022-04-038-56/+109
|\ \ | |/
| * Merge branch '4.x'Takeshi KOMIYA2022-03-276-25/+21
| |\
| | * extlinks: Disable hardcoded links detector by default (refs: #10126)Takeshi KOMIYA2022-03-271-0/+8
| | | | | | | | | | | | | | | | | | The hardcoded links detector added since 4.4.0 causes troubles in many projects. Therefore, this disables it by default, and adds a new configuration `extlinks_detect_hardcoded_links` to enable it explicitly.
| | * doc: Use :pep: role to refer PEP documentsTakeshi KOMIYA2022-03-275-24/+12
| | |
| | * Update PEP links in docsHugo van Kemenade2022-03-245-8/+8
| | |
| * | Merge branch '4.x'Takeshi KOMIYA2022-02-191-1/+5
| |\ \ | | |/
| | * Update doc/usage/extensions/autodoc.rstTakeshi KOMIYA2022-02-061-1/+1
| | |
| | * Close #10146: autodoc: autodoc_default_options does not support `no-value` ↵Takeshi KOMIYA2022-01-311-1/+5
| | | | | | | | | | | | option
| * | Merge commit '07110b7557a552ecfe702bdd6a2d2f9685cb1af9'Takeshi KOMIYA2022-02-141-2/+2
| |\ \ | | |/
| | * Update autosummary.rstTimo Cornelius Metzger2022-01-271-2/+2
| | |
| * | 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
| | |
| * | 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
| * | 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-111-0/+7
| |\ \ | | |/
| | * 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'Takeshi KOMIYA2021-11-281-0/+19
| |\ \ | | |/
| * | Merge branch '4.x'Takeshi KOMIYA2021-11-231-0/+5
| |\ \
| * | | 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-231-1/+1
| |\ \ \ \