summaryrefslogtreecommitdiff
path: root/doc/extdev
Commit message (Collapse)AuthorAgeFilesLines
* Deprecate HTML 4 support (#10843)Adam Turner2022-09-231-0/+5
|
* Add contents entries for domain objects (#10807)Adam Turner2022-09-131-0/+1
| | | | | | | | | - Add entries in the table of contents for domain objects (e.g. `py:function`, `rst:role`, etc). Supported domains are Javascript, Python, and reStructuredText. - Support content in `py:module` and `js:module` directives. - Add the `noindexentry` and `noindex` flags to more domains. - Add `toc_object_entries_show_parents` configuration setting - Update documentation and tests
* Do not apply epigraph style to all block quotesAdam Turner2022-09-121-28/+28
| | | | | | | Correct indentation where appropriate for stanzas that should not be rendered as `<blockquote>` HTML elements. Closes GH-10686
* Add `include_patterns` as the opposite of `exclude_patterns` (#10518)Adam Turner2022-07-171-0/+10
|
* Replace `napoleon.iterators` by simpler stack implementation (#9856)Antony Lee2022-06-261-0/+5
|
* Simplify Sphinx's Stemmer (#10467)Adam Turner2022-06-161-0/+5
|
* Replace doclinter with sphinx-lint (#10389)Julien Palard2022-06-161-1/+1
| | | Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
* Mark sphinx.io:read_doc() deprecatedTakeshi KOMIYA2022-05-081-0/+5
|
* Remove sphinx.util.docutils.__version_info__ on 7.0Takeshi KOMIYA2022-05-031-0/+5
|
* Deprecate: html5_ready and is_html5_writer_available()Takeshi KOMIYA2022-05-031-0/+10
|
* Schedule removal for 7.0Adam Turner2022-04-301-1/+1
|
* Deprecate `sphinx.util.jsdump`Adam Turner2022-04-271-0/+5
|
* fix typoTakayuki SHIMIZUKAWA2022-04-191-1/+1
| | | from https://github.com/sphinx-doc/sphinx-doc-translations/pull/13
* Merge branch '4.x'Takeshi KOMIYA2022-03-271-0/+1
|\
| * doc: Update docs for sphinx.parsers.ParserTakeshi KOMIYA2022-03-271-0/+1
| |
* | Merge branch '4.x'Takeshi KOMIYA2022-02-191-0/+5
|\ \ | |/
| * Fix #10181: napoleon_use_ivar adds unexpected prefix to varsTakeshi KOMIYA2022-02-121-0/+5
| | | | | | | | | | | | | | | | Since 4.0, :ivar: items has not been rendered as hyperlinks. So any modules, classes and tilda are now harmful. This removes the prefixing filter for napoleon_use_ivar option. refs: #5129 and #5977
* | Merge commit '07110b7557a552ecfe702bdd6a2d2f9685cb1af9'Takeshi KOMIYA2022-02-141-1/+3
|\ \ | |/
| * Mention nitpick_ignore(_regex) in docs of warn-missing-referenceHinrich Mahler2022-01-181-1/+3
| |
* | Close #10062: Change the default language to 'en'Takeshi KOMIYA2022-01-121-0/+10
| | | | | | | | | | Change the default language to `'en'` if any language is not set in `conf.py`.
* | Close #9595: Deprecate setuptools integrationTakeshi KOMIYA2022-01-011-0/+5
| |
* | Deprecate sphinx.writers.latex.LaTeXWriter.docclassesTakeshi KOMIYA2021-12-181-0/+5
|/
* Fix #9752: autodoc: Failed to detect type annotation for slots attributeTakeshi KOMIYA2021-10-231-0/+5
|
* Fix #9710: html: Wrong styles for even/odd rows in nested tablesTakeshi KOMIYA2021-10-091-0/+20
|
* Merge branch '4.x' into 9683_add_css_fileTakeshi KOMIYA2021-10-091-0/+5
|\
| * js nodes, docs, add entry in deprecation/removal tableJakob Lykke Andersen2021-10-031-0/+5
| |
* | Close #9683: Revert the removal of ``add_stylesheet()`` APITakeshi KOMIYA2021-10-031-1/+1
|/ | | | | | | It will be kept until the Sphinx-6.0 release. Note: Now it emits a warning instead of DeprecationWarning to let the users know the deprecation.
* Merge pull request #9666 from tk0miya/9662_docs_for_ObjectDescriptionTakeshi KOMIYA2021-09-271-0/+4
|\ | | | | Add doc for ObjectDescription (refs: #9662)
| * Add doc for ObjectDescription (refs: #9662)Takeshi KOMIYA2021-09-231-0/+4
| |
* | Fix #9637: Add Builder.allow_parallel to the list of builder APIsTakeshi KOMIYA2021-09-181-0/+1
|/
* Fix typoEisuke Kawashima2021-07-081-2/+2
|
* Merge branch '4.0.x' into 4.xTakeshi KOMIYA2021-06-301-1/+1
|\
| * Revert the removal of sphinx.util:force_decode()Takeshi KOMIYA2021-06-131-1/+1
| | | | | | | | | | | | | | | | | | | | After the release of 4.0.0, some 3rd party extensions have became not working with the latest Sphinx because `force_decode()` function was removed. It was deprecated since Sphinx-2.0 and warned for the removal since 3.0. This reverts the removal and extends its deprecation period to 5.0.0. I hope it helps users of these extensions.
* | Fix #9032: docs: sphinx.environment.NoUri was removed at v3.0.0Takeshi KOMIYA2021-06-141-1/+2
| | | | | | | | | | Our deprecation list describes `sphinx.environment.NoUri` was removed at v4.0.0. But, acutally, it was removed at v3.0.0 (#6223).
* | Merge pull request #9303 from tk0miya/fix_docslintTakeshi KOMIYA2021-06-061-5/+8
|\ \ | | | | | | doc: Fix docslint misunderstanding scope of code-blocks
| * | doc: Fix docslint misunderstanding scope of code-blocksTakeshi KOMIYA2021-06-061-5/+8
| | |
* | | Merge pull request #9260 from tk0miya/9016_linkcheck_github_anchorsTakeshi KOMIYA2021-06-041-0/+8
|\ \ \ | |/ / |/| | Close #9016: linkcheck builder failed to check the anchors of github.com
| * | Close #9016: linkcheck builder failed to check the anchors of github.comTakeshi KOMIYA2021-06-011-0/+8
| | |
* | | deprecate sphinx.ext.autosummary._appTakeshi KOMIYA2021-05-311-0/+5
|/ /
* | Merge pull request #9242 from tk0miya/refactor_env2Takeshi KOMIYA2021-05-221-0/+5
|\ \ | | | | | | refactor: Make the app argument for BuildEnvironment required
| * | refactor: Make the app argument for BuildEnvironment requiredTakeshi KOMIYA2021-05-221-0/+5
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | At present, some attributes of env object are considered as optional because they have been initialized by None on the constructor. But they have always been fullfilled actually. To be clear the type hints of the env object, this makes the `app` argument for the BuildEnvironment class required. It can ensure the attributes of env object are not optional.
* | | doc: Upgraded babel.pocoo.org links to HTTPSigo958622021-05-161-1/+1
| | |
* | | doc: Upgrade docutils.sourceforge.io links to HTTPSigo958622021-05-163-3/+3
|/ / | | | | | | | | Also change any docutils.sourceforge.net link to io top level domain.
* | Deprecate app.html_themesTakeshi KOMIYA2021-05-121-0/+5
| | | | | | | | | | The register is much better to store the HTML themes instead of the application object. So this migrates it to the registry object.
* | Fix typos in doc/extdev/deprecated.rstDmitry Shachnev2021-05-091-3/+3
| |
* | Fix #8597: autodoc: metadata only docstring is treated as undocumentedTakeshi KOMIYA2021-05-021-0/+5
|/ | | | | The metadata in docstring is invisible content. Therefore docstring having only metadata should be treated as undocumented.
* Merge pull request #9050 from tk0miya/8829_whats_parallel_read_safeTakeshi KOMIYA2021-04-181-0/+16
|\ | | | | Close #8829: doc: Update description of paralle-read-safe
| * Close #8829: doc: Update description of paralle-read-safeTakeshi KOMIYA2021-04-041-0/+16
| |
* | Decl styling, make desc_inline nodeJakob Lykke Andersen2021-04-121-0/+1
| | | | | | | | Use the new node for cpp:expr
* | Decl styling, docs and restructuringJakob Lykke Andersen2021-04-121-2/+15
|/