Commit message (Collapse) | Author | Age | Files | Lines | |
---|---|---|---|---|---|
* | Enable 'nit-picky mode' for Sphinx's documentation | Adam Turner | 2023-04-06 | 2 | -4/+9 |
| | | | | | Fix several reference errors throughout the documentation and set ``nitpick_ignore`` in ``doc/conf.py``. | ||||
* | Update doc and CHANGES for PR #11281 | Jean-François B | 2023-04-03 | 1 | -0/+25 |
| | |||||
* | Docs: Add a link to sphinx-extensions (#11260) | Benjamin Balder Bach | 2023-03-23 | 1 | -2/+4 |
| | |||||
* | Deprecate legacy ``intersphinx_mapping`` format (#11247) | Adam Turner | 2023-03-17 | 1 | -11/+23 |
| | | | This format was made obsolete in Sphinx 1.0, but never formally deprecated. | ||||
* | Documentation reshuffle (#11112) | Adam Turner | 2023-01-08 | 1 | -0/+1 |
| | |||||
* | Document autosummary template variable "objtype" (#11044) | Tim Hoffmann | 2023-01-02 | 1 | -0/+6 |
| | |||||
* | Run the ``pyupgrade`` tool | Adam Turner | 2022-10-17 | 2 | -4/+2 |
| | |||||
* | Add debug logging to `autosectionlabel` (#10881) | Martin Patz | 2022-10-04 | 1 | -0/+9 |
| | | | Co-authored-by: Martin Patz <martin@recogni.com> | ||||
* | imgmath: Allow embedding images in HTML as base64 (#10816) | Julien Schueller | 2022-09-23 | 1 | -0/+6 |
| | | | Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com> | ||||
* | Do not apply epigraph style to all block quotes | Adam Turner | 2022-09-12 | 2 | -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 Janhangeer | 2022-08-04 | 1 | -2/+0 |
| | | | Co-authored-by: Jean-François B. <2589111+jfbu@users.noreply.github.com> | ||||
* | Fix indentation of .. version{changed,added}. | marxin | 2022-07-19 | 1 | -2/+2 |
| | |||||
* | Remove traces of Python 2 and 3.5 (#10560) | Adam Turner | 2022-06-16 | 1 | -2/+2 |
| | |||||
* | Replace doclinter with sphinx-lint (#10389) | Julien Palard | 2022-06-16 | 2 | -3/+3 |
| | | | Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com> | ||||
* | Merge pull request #10386 from mxd4/10384-comment-img-magick | Takeshi KOMIYA | 2022-05-22 | 1 | -7/+10 |
|\ | | | | | Add comments on ImageMagick requirement | ||||
| * | #10384 - Grammar | mxd4 | 2022-05-02 | 1 | -3/+3 |
| | | |||||
| * | #10384 - Fix flake8 | mxd4 | 2022-05-02 | 1 | -1/+1 |
| | | |||||
| * | #10384 - Explicit warning and improve doc clarity | mxd4 | 2022-05-02 | 1 | -7/+9 |
| | | |||||
| * | #10384 - Changes after suggestions | mxd4 | 2022-05-02 | 1 | -3/+3 |
| | | |||||
| * | #10384 - Add line break to fix docslint | mxd4 | 2022-05-02 | 1 | -1/+2 |
| | | |||||
| * | #10384 - Add comment on ImageMagick requirement | mxd4 | 2022-05-02 | 1 | -1/+1 |
| | | |||||
* | | sphinx.ext.napoleon docs: fix Google style link | Stefaan Lippens | 2022-04-25 | 1 | -2/+2 |
|/ | |||||
* | Merge branch '5.x' into autodoc_force_undocumented_rtype | Takeshi KOMIYA | 2022-04-03 | 1 | -0/+8 |
|\ | |||||
| * | Close #8417: autodoc: :inherited-members: option now takes multiple classes | Takeshi KOMIYA | 2022-04-03 | 1 | -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 KOMIYA | 2022-04-03 | 1 | -5/+5 |
| | | | | | | | | returnvalue_and_documented_params to documented_params | ||||
* | | Merge branch '5.x' into autodoc_force_undocumented_rtype | Takeshi KOMIYA | 2022-04-03 | 8 | -56/+109 |
|\ \ | |/ | |||||
| * | Merge branch '4.x' | Takeshi KOMIYA | 2022-03-27 | 6 | -25/+21 |
| |\ | |||||
| | * | extlinks: Disable hardcoded links detector by default (refs: #10126) | Takeshi KOMIYA | 2022-03-27 | 1 | -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 documents | Takeshi KOMIYA | 2022-03-27 | 5 | -24/+12 |
| | | | |||||
| | * | Update PEP links in docs | Hugo van Kemenade | 2022-03-24 | 5 | -8/+8 |
| | | | |||||
| * | | Merge branch '4.x' | Takeshi KOMIYA | 2022-02-19 | 1 | -1/+5 |
| |\ \ | | |/ | |||||
| | * | Update doc/usage/extensions/autodoc.rst | Takeshi KOMIYA | 2022-02-06 | 1 | -1/+1 |
| | | | |||||
| | * | Close #10146: autodoc: autodoc_default_options does not support `no-value` ↵ | Takeshi KOMIYA | 2022-01-31 | 1 | -1/+5 |
| | | | | | | | | | | | | option | ||||
| * | | Merge commit '07110b7557a552ecfe702bdd6a2d2f9685cb1af9' | Takeshi KOMIYA | 2022-02-14 | 1 | -2/+2 |
| |\ \ | | |/ | |||||
| | * | Update autosummary.rst | Timo Cornelius Metzger | 2022-01-27 | 1 | -2/+2 |
| | | | |||||
| * | | Merge branch '4.x' | Takeshi KOMIYA | 2022-01-17 | 1 | -23/+57 |
| |\ \ | | |/ | |||||
| | * | intersphinx role, update docs | Jakob Lykke Andersen | 2022-01-16 | 1 | -6/+6 |
| | | | |||||
| | * | intersphinx role, documentation | Jakob Lykke Andersen | 2022-01-16 | 1 | -23/+57 |
| | | | |||||
| * | | autodoc: The default of autodoc_typehints_format becomes to 'smart' | Takeshi KOMIYA | 2022-01-02 | 1 | -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 KOMIYA | 2022-01-01 | 1 | -3/+8 |
| |\ \ | | |/ | |||||
| | * | autodoc: Rename autodoc_unqualified_typehints to autodoc_typehints_format ↵ | Takeshi KOMIYA | 2021-12-24 | 1 | -3/+8 |
| | | | | | | | | | | | | (refs: #9931) | ||||
| * | | Merge branch '4.x' | Takeshi KOMIYA | 2021-12-24 | 1 | -2/+2 |
| |\ \ | | |/ | |||||
| | * | doc: Update explanation of autodoc_unqualified_typehints (ref: #9931) | Takeshi KOMIYA | 2021-12-18 | 1 | -2/+2 |
| | | | |||||
| * | | Merge branch '4.x' | Takeshi KOMIYA | 2021-12-11 | 1 | -0/+7 |
| |\ \ | | |/ | |||||
| | * | Close #9075: autodoc: Add a config variable autodoc_unqualified_typehints | Takeshi KOMIYA | 2021-12-03 | 1 | -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 KOMIYA | 2021-11-28 | 1 | -0/+19 |
| |\ \ | | |/ | |||||
| * | | Merge branch '4.x' | Takeshi KOMIYA | 2021-11-23 | 1 | -0/+5 |
| |\ \ | |||||
| * | | | Change default value of intersphinx_disabled_reftypes | Jakob Lykke Andersen | 2021-10-31 | 1 | -1/+5 |
| | | | | | | | | | | | | | | | | See discussion in sphinx-doc/sphinx#9459 | ||||
| * | | | Merge branch '4.x' | Jakob Lykke Andersen | 2021-10-31 | 1 | -0/+29 |
| |\ \ \ | |||||
| * \ \ \ | Merge branch '4.x' | Takeshi KOMIYA | 2021-10-23 | 1 | -1/+1 |
| |\ \ \ \ |