chore(deps): update dependency sphinx to v7

[renovate[bot]]

This PR contains the following updates:

Package	Change	Age	Adoption	Passing	Confidence
sphinx (changelog)	<4.0 -> <7.1

---

Release Notes

sphinx-doc/sphinx

### [`v7.0.0`](https://togithub.com/sphinx-doc/sphinx/blob/HEAD/CHANGES#Release-700-released-Apr-29-2023) [Compare Source](https://togithub.com/sphinx-doc/sphinx/compare/v6.2.1...v7.0.0) \===================================== ## Incompatible changes - [#​11359](https://togithub.com/sphinx-doc/sphinx/issues/11359): Remove long-deprecated aliases for `MecabSplitter` and `DefaultSplitter` in `sphinx.search.ja`. - [#​11360](https://togithub.com/sphinx-doc/sphinx/issues/11360): Remove deprecated `make_old_id` functions in domain object description classes. - [#​11363](https://togithub.com/sphinx-doc/sphinx/issues/11363): Remove the Setuptools integration (`build_sphinx` hook in `setup.py`). - [#​11364](https://togithub.com/sphinx-doc/sphinx/issues/11364): Remove deprecated `sphinx.ext.napoleon.iterators` module. - [#​11365](https://togithub.com/sphinx-doc/sphinx/issues/11365): Remove support for the `jsdump` format in `sphinx.search`. - [#​11366](https://togithub.com/sphinx-doc/sphinx/issues/11366): Make `locale` a required argument to `sphinx.util.i18n.format_date()`. - [#​11370](https://togithub.com/sphinx-doc/sphinx/issues/11370): Remove deprecated `sphinx.util.stemmer` module. - [#​11371](https://togithub.com/sphinx-doc/sphinx/issues/11371): Remove deprecated `sphinx.pycode.ast.parse()` function. - [#​11372](https://togithub.com/sphinx-doc/sphinx/issues/11372): Remove deprecated `sphinx.io.read_doc()` function. - [#​11373](https://togithub.com/sphinx-doc/sphinx/issues/11373): Removed deprecated `sphinx.util.get_matching_files()` function. - [#​11378](https://togithub.com/sphinx-doc/sphinx/issues/11378): Remove deprecated `sphinx.util.docutils.is_html5_writer_available()` function. - [#​11379](https://togithub.com/sphinx-doc/sphinx/issues/11379): Make the `env` argument to `Builder` subclasses required. - [#​11380](https://togithub.com/sphinx-doc/sphinx/issues/11380): autosummary: Always emit grouped import exceptions. - [#​11381](https://togithub.com/sphinx-doc/sphinx/issues/11381): Remove deprecated `style` key for HTML templates. - [#​11382](https://togithub.com/sphinx-doc/sphinx/issues/11382): Remove deprecated `sphinx.writers.latex.LaTeXTranslator.docclasses` attribute. - [#​11383](https://togithub.com/sphinx-doc/sphinx/issues/11383): Remove deprecated `sphinx.builders.html.html5_ready` and `sphinx.builders.html.HTMLTranslator` attributes. - [#​11385](https://togithub.com/sphinx-doc/sphinx/issues/11385): Remove support for HTML 4 output. ### [`v6.2.1`](https://togithub.com/sphinx-doc/sphinx/blob/HEAD/CHANGES#Release-621-released-Apr-25-2023) [Compare Source](https://togithub.com/sphinx-doc/sphinx/compare/v6.2.0...v6.2.1) \===================================== ## Bugs fixed - [#​11355](https://togithub.com/sphinx-doc/sphinx/issues/11355): Revert the default type of :confval:`nitpick_ignore` and :confval:`nitpick_ignore_regex` to `list`. ### [`v6.2.0`](https://togithub.com/sphinx-doc/sphinx/blob/HEAD/CHANGES#Release-620-released-Apr-23-2023) [Compare Source](https://togithub.com/sphinx-doc/sphinx/compare/v6.1.3...v6.2.0) \===================================== ## Dependencies - Require Docutils 0.18.1 or greater. ## Incompatible changes - LaTeX: removal of some internal TeX `\dimen` registers (not previously publicly documented) as per 5.1.0 code comments in `sphinx.sty`: `\sphinxverbatimsep`, `\sphinxverbatimborder`, `\sphinxshadowsep`, `\sphinxshadowsize`, and `\sphinxshadowrule`. (refs: [#​11105](https://togithub.com/sphinx-doc/sphinx/issues/11105)) - Remove `.egg` support from pycode `ModuleAnalyser`; Python eggs are a now-obsolete binary distribution format - [#​11089](https://togithub.com/sphinx-doc/sphinx/issues/11089): Remove deprecated code in `sphinx.builders.linkcheck`. Patch by Daniel Eades - Remove internal-only `sphinx.locale.setlocale` ## Deprecated - [#​11247](https://togithub.com/sphinx-doc/sphinx/issues/11247): Deprecate the legacy `intersphinx_mapping` format - `sphinx.util.osutil.cd` is deprecated in favour of `contextlib.chdir`. ## Features added - [#​11277](https://togithub.com/sphinx-doc/sphinx/issues/11277): :rst:dir:`autoproperty` allows the return type to be specified as a type comment (e.g., `# type: () -> int`). Patch by Bénédikt Tran - [#​10811](https://togithub.com/sphinx-doc/sphinx/issues/10811): Autosummary: extend `__all__` to imported members for template rendering when option `autosummary_ignore_module_all` is set to `False`. Patch by Clement Pinard - [#​11147](https://togithub.com/sphinx-doc/sphinx/issues/11147): Add a `content_offset` parameter to `nested_parse_with_titles()`, allowing for correct line numbers during nested parsing. Patch by Jeremy Maitin-Shepard - Update to Unicode CLDR 42 - Add a `--jobs` synonym for `-j`. Patch by Hugo van Kemenade - LaTeX: a command `\sphinxbox` for styling text elements with a (possibly rounded) box, optional background color and shadow, has been added. See :ref:`sphinxbox`. (refs: [#​11224](https://togithub.com/sphinx-doc/sphinx/issues/11224)) - LaTeX: add `\sphinxstylenotetitle`, ..., `\sphinxstylewarningtitle`, ..., for an extra layer of mark-up freeing up `\sphinxstrong` for other uses. See :ref:`latex-macros`. (refs: [#​11267](https://togithub.com/sphinx-doc/sphinx/issues/11267)) - LaTeX: :dudir:`note`, :dudir:`hint`, :dudir:`important` and :dudir:`tip` can now each be styled as the other admonitions, i.e. possibly with a background color, individual border widths and paddings, possibly rounded corners, and optional shadow. See :ref:`additionalcss`. (refs: [#​11234](https://togithub.com/sphinx-doc/sphinx/issues/11234)) - LaTeX: admonitions and :dudir:`topic` (and :dudir:`contents `) directives, and not only :rst:dir:`code-block`, support `box-decoration-break=slice`. - LaTeX: let rounded boxes support up to 4 distinct border-widths (refs: [#​11243](https://togithub.com/sphinx-doc/sphinx/issues/11243)) - LaTeX: new options `noteTextColor`, `noteTeXextras` et al. See :ref:`additionalcss`. - LaTeX: support elliptical corners in rounded boxes. (refs: [#​11254](https://togithub.com/sphinx-doc/sphinx/issues/11254)) - [#​11150](https://togithub.com/sphinx-doc/sphinx/issues/11150): Include source location in highlighting warnings, when lexing fails. Patch by Jeremy Maitin-Shepard - [#​11281](https://togithub.com/sphinx-doc/sphinx/issues/11281): Support for :confval:`imgmath_latex` `= 'tectonic'` or `= 'xelatex'`. Patch by Dimitar Dimitrov - [#​11109](https://togithub.com/sphinx-doc/sphinx/issues/11109), [#​9643](https://togithub.com/sphinx-doc/sphinx/issues/9643): Add :confval:`python_display_short_literal_types` option for condensed rendering of `Literal` types. ## Bugs fixed - [#​11079](https://togithub.com/sphinx-doc/sphinx/issues/11079): LaTeX: figures with align attribute may disappear and strangely impact following lists - [#​11093](https://togithub.com/sphinx-doc/sphinx/issues/11093): LaTeX: fix "multiply-defined references" PDF build warnings when one or more reST labels directly precede an :rst:dir:`py:module` or :rst:dir:`automodule` directive. Patch by Bénédikt Tran (picnixz) - [#​11110](https://togithub.com/sphinx-doc/sphinx/issues/11110): LaTeX: Figures go missing from latex pdf if their files have the same base name and they use a post transform. Patch by aaron-cooper - LaTeX: fix potential color leak from shadow to border of rounded boxes, if shadow color is set but border color is not - LaTeX: fix unintended 1pt upwards vertical shift of code blocks frames respective to contents (when using rounded corners) - [#​11235](https://togithub.com/sphinx-doc/sphinx/issues/11235): LaTeX: added `\color` in topic (or admonition) contents may cause color leak to the shadow and border at a page break - [#​11264](https://togithub.com/sphinx-doc/sphinx/issues/11264): LaTeX: missing space before colon after "Voir aussi" for :rst:dir:`seealso` directive in French - [#​11268](https://togithub.com/sphinx-doc/sphinx/issues/11268): LaTeX: longtable with left alignment breaks out of current list indentation context in PDF. Thanks to picnixz. - [#​11274](https://togithub.com/sphinx-doc/sphinx/issues/11274): LaTeX: external links are not properly escaped for `\sphinxupquote` compatibility - [#​11147](https://togithub.com/sphinx-doc/sphinx/issues/11147): Fix source file/line number info in object description content and in other uses of `nested_parse_with_titles`. Patch by Jeremy Maitin-Shepard. - [#​11192](https://togithub.com/sphinx-doc/sphinx/issues/11192): Restore correct parallel search index building. Patch by Jeremy Maitin-Shepard - Use the new Transifex `tx` client ## Testing - Fail testing when any Python warnings are emitted - Migrate remaining `unittest.TestCase` style test functions to pytest style - Remove tests that rely on setuptools ### [`v6.1.3`](https://togithub.com/sphinx-doc/sphinx/blob/HEAD/CHANGES#Release-613-released-Jan-10-2023) [Compare Source](https://togithub.com/sphinx-doc/sphinx/compare/v6.1.2...v6.1.3) \===================================== ## Bugs fixed - [#​11116](https://togithub.com/sphinx-doc/sphinx/issues/11116): Reverted to previous Sphinx 5 node copying method - [#​11117](https://togithub.com/sphinx-doc/sphinx/issues/11117): Reverted changes to parallel image processing from Sphinx 6.1.0 - [#​11119](https://togithub.com/sphinx-doc/sphinx/issues/11119): Supress `ValueError` in the `linkcheck` builder ### [`v6.1.2`](https://togithub.com/sphinx-doc/sphinx/blob/HEAD/CHANGES#Release-612-released-Jan-07-2023) [Compare Source](https://togithub.com/sphinx-doc/sphinx/compare/v6.1.1...v6.1.2) \===================================== ## Bugs fixed - [#​11101](https://togithub.com/sphinx-doc/sphinx/issues/11101): LaTeX: `div.topic_padding` key of sphinxsetup documented at 5.1.0 was implemented with name `topic_padding` - [#​11099](https://togithub.com/sphinx-doc/sphinx/issues/11099): LaTeX: `shadowrule` key of sphinxsetup causes PDF build to crash since Sphinx 5.1.0 - [#​11096](https://togithub.com/sphinx-doc/sphinx/issues/11096): LaTeX: `shadowsize` key of sphinxsetup causes PDF build to crash since Sphinx 5.1.0 - [#​11095](https://togithub.com/sphinx-doc/sphinx/issues/11095): LaTeX: shadow of :dudir:`topic` and :dudir:`contents ` boxes not in page margin since Sphinx 5.1.0 - [#​11100](https://togithub.com/sphinx-doc/sphinx/issues/11100): Fix copying images when running under parallel mode. ### [`v6.1.1`](https://togithub.com/sphinx-doc/sphinx/blob/HEAD/CHANGES#Release-611-released-Jan-05-2023) [Compare Source](https://togithub.com/sphinx-doc/sphinx/compare/v6.1.0...v6.1.1) \===================================== ## Bugs fixed - [#​11091](https://togithub.com/sphinx-doc/sphinx/issues/11091): Fix `util.nodes.apply_source_workaround` for `literal_block` nodes with no source information in the node or the node's parents. ### [`v6.1.0`](https://togithub.com/sphinx-doc/sphinx/blob/HEAD/CHANGES#Release-610-released-Jan-05-2023) [Compare Source](https://togithub.com/sphinx-doc/sphinx/compare/v6.0.1...v6.1.0) \===================================== ## Dependencies - Adopted the `Ruff`\_ code linter. .. \_Ruff: https://github.com/charliermarsh/ruff ## Incompatible changes - [#​10979](https://togithub.com/sphinx-doc/sphinx/issues/10979): gettext: Removed support for pluralisation in `get_translation`. This was unused and complicated other changes to `sphinx.locale`. ## Deprecated - `sphinx.util` functions: - Renamed `sphinx.util.typing.stringify()` to `sphinx.util.typing.stringify_annotation()` - Moved `sphinx.util.xmlname_checker()` to `sphinx.builders.epub3._XML_NAME_PATTERN` Moved to `sphinx.util.display`: - `sphinx.util.status_iterator` - `sphinx.util.display_chunk` - `sphinx.util.SkipProgressMessage` - `sphinx.util.progress_message` Moved to `sphinx.util.http_date`: - `sphinx.util.epoch_to_rfc1123` - `sphinx.util.rfc1123_to_epoch` Moved to `sphinx.util.exceptions`: - `sphinx.util.save_traceback` - `sphinx.util.format_exception_cut_frames` ## Features added - Cache doctrees in the build environment during the writing phase. - Make all writing phase tasks support parallel execution. - [#​11072](https://togithub.com/sphinx-doc/sphinx/issues/11072): Use PEP 604 (`X | Y`) display conventions for `typing.Optional` and `typing.Optional` types within the Python domain and autodoc. - [#​10700](https://togithub.com/sphinx-doc/sphinx/issues/10700): autodoc: Document `typing.NewType()` types as classes rather than 'data'. - Cache doctrees between the reading and writing phases. ## Bugs fixed - [#​10962](https://togithub.com/sphinx-doc/sphinx/issues/10962): HTML: Fix the multi-word key name lookup table. - Fixed support for Python 3.12 alpha 3 (changes in the `enum` module). - [#​11069](https://togithub.com/sphinx-doc/sphinx/issues/11069): HTML Theme: Removed outdated "shortcut" link relation keyword. - [#​10952](https://togithub.com/sphinx-doc/sphinx/issues/10952): Properly terminate parallel processes on programme interuption. - [#​10988](https://togithub.com/sphinx-doc/sphinx/issues/10988): Speed up `TocTree.resolve()` through more efficient copying. - [#​6744](https://togithub.com/sphinx-doc/sphinx/issues/6744): LaTeX: support for seealso directive should be via an environment to allow styling. - [#​11074](https://togithub.com/sphinx-doc/sphinx/issues/11074): LaTeX: Can't change sphinxnote to use sphinxheavybox starting with 5.1.0 ### [`v6.0.1`](https://togithub.com/sphinx-doc/sphinx/blob/HEAD/CHANGES#Release-601-released-Jan-05-2023) [Compare Source](https://togithub.com/sphinx-doc/sphinx/compare/v6.0.0...v6.0.1) \===================================== ## Dependencies - Require Pygments 2.13 or later. ## Bugs fixed - [#​10944](https://togithub.com/sphinx-doc/sphinx/issues/10944): imgmath: Fix resolving image paths for files in nested folders. ### [`v6.0.0`](https://togithub.com/sphinx-doc/sphinx/blob/HEAD/CHANGES#Release-600-released-Dec-29-2022) [Compare Source](https://togithub.com/sphinx-doc/sphinx/compare/v5.3.0...v6.0.0) \===================================== ## Dependencies - [#​10468](https://togithub.com/sphinx-doc/sphinx/issues/10468): Drop Python 3.6 support - [#​10470](https://togithub.com/sphinx-doc/sphinx/issues/10470): Drop Python 3.7, Docutils 0.14, Docutils 0.15, Docutils 0.16, and Docutils 0.17 support. Patch by Adam Turner ## Incompatible changes - [#​7405](https://togithub.com/sphinx-doc/sphinx/issues/7405): Removed the jQuery and underscore.js JavaScript frameworks. These frameworks are no longer be automatically injected into themes from Sphinx 6.0. If you develop a theme or extension that uses the `jQuery`, `$`, or `$u` global objects, you need to update your JavaScript to modern standards, or use the mitigation below. The first option is to use the sphinxcontrib.jquery\_ extension, which has been developed by the Sphinx team and contributors. To use this, add `sphinxcontrib.jquery` to the `extensions` list in `conf.py`, or call `app.setup_extension("sphinxcontrib.jquery")` if you develop a Sphinx theme or extension. The second option is to manually ensure that the frameworks are present. To re-add jQuery and underscore.js, you will need to copy `jquery.js` and `underscore.js` from `the Sphinx repository`\_ to your `static` directory, and add the following to your `layout.html`: .. code-block:: html+jinja {%- block scripts %} {{ super() }} {%- endblock %} .. \_sphinxcontrib.jquery: https://github.com/sphinx-contrib/jquery/ Patch by Adam Turner. - [#​10471](https://togithub.com/sphinx-doc/sphinx/issues/10471), [#​10565](https://togithub.com/sphinx-doc/sphinx/issues/10565): Removed deprecated APIs scheduled for removal in Sphinx 6.0. See :ref:`dev-deprecated-apis` for details. Patch by Adam Turner. - [#​10901](https://togithub.com/sphinx-doc/sphinx/issues/10901): C Domain: Remove support for parsing pre-v3 style type directives and roles. Also remove associated configuration variables `c_allow_pre_v3` and `c_warn_on_allowed_pre_v3`. Patch by Adam Turner. ## Features added - [#​10924](https://togithub.com/sphinx-doc/sphinx/issues/10924): LaTeX: adopt better looking defaults for tables and code-blocks. See :confval:`latex_table_style` and the `pre_border-radius` and `pre_background-TeXcolor` :ref:`additionalcss` for the former defaults and how to re-enact them if desired. ## Bugs fixed - [#​10984](https://togithub.com/sphinx-doc/sphinx/issues/10984): LaTeX: Document :confval:`latex_additional_files` behavior for files with `.tex` extension. ### [`v5.3.0`](https://togithub.com/sphinx-doc/sphinx/blob/HEAD/CHANGES#Release-530-released-Oct-16-2022) [Compare Source](https://togithub.com/sphinx-doc/sphinx/compare/v5.2.3...v5.3.0) \===================================== - [#​10759](https://togithub.com/sphinx-doc/sphinx/issues/10759): LaTeX: add :confval:`latex_table_style` and support the `'booktabs'`, `'borderless'`, and `'colorrows'` styles. (thanks to Stefan Wiehler for initial pull requests [#​6666](https://togithub.com/sphinx-doc/sphinx/issues/6666), [#​6671](https://togithub.com/sphinx-doc/sphinx/issues/6671)) - [#​10840](https://togithub.com/sphinx-doc/sphinx/issues/10840): One can cross-reference including an option value like `` :option:`--module=foobar```, ``:option:`--module[=foobar]``` or ``:option:`--module foobar\`\`\`. Patch by Martin Liska. - [#​10881](https://togithub.com/sphinx-doc/sphinx/issues/10881): autosectionlabel: Record the generated section label to the debug log. - [#​10268](https://togithub.com/sphinx-doc/sphinx/issues/10268): Correctly URI-escape image filenames. - [#​10887](https://togithub.com/sphinx-doc/sphinx/issues/10887): domains: Allow sections in all the content of all object description directives (e.g. :rst:dir:`py:function`). Patch by Adam Turner ### [`v5.2.3`](https://togithub.com/sphinx-doc/sphinx/blob/HEAD/CHANGES#Release-523-released-Sep-30-2022) [Compare Source](https://togithub.com/sphinx-doc/sphinx/compare/v5.2.2...v5.2.3) \===================================== - [#​10878](https://togithub.com/sphinx-doc/sphinx/issues/10878): Fix base64 image embedding in `sphinx.ext.imgmath` - [#​10886](https://togithub.com/sphinx-doc/sphinx/issues/10886): Add `:nocontentsentry:` flag and global domain table of contents entry control option. Patch by Adam Turner ### [`v5.2.2`](https://togithub.com/sphinx-doc/sphinx/blob/HEAD/CHANGES#Release-522-released-Sep-27-2022) [Compare Source](https://togithub.com/sphinx-doc/sphinx/compare/v5.2.1...v5.2.2) \===================================== - [#​10872](https://togithub.com/sphinx-doc/sphinx/issues/10872): Restore link targets for autodoc modules to the top of content. Patch by Dominic Davis-Foster. ### [`v5.2.1`](https://togithub.com/sphinx-doc/sphinx/blob/HEAD/CHANGES#Release-521-released-Sep-25-2022) \===================================== ## Bugs fixed - [#​10861](https://togithub.com/sphinx-doc/sphinx/issues/10861): Always normalise the `pycon3` lexer to `pycon`. - Fix using `sphinx.ext.autosummary` with modules containing titles in the module-level docstring. ### [`v5.2.0.post0`](https://togithub.com/sphinx-doc/sphinx/blob/HEAD/CHANGES#Release-520post0-released-Sep-24-2022) \=========================================== - Recreated source tarballs for Debian maintainers. ### [`v5.2.0`](https://togithub.com/sphinx-doc/sphinx/blob/HEAD/CHANGES#Release-520post0-released-Sep-24-2022) [Compare Source](https://togithub.com/sphinx-doc/sphinx/compare/v5.1.1...v5.2.0) \=========================================== - Recreated source tarballs for Debian maintainers. ### [`v5.1.1`](https://togithub.com/sphinx-doc/sphinx/blob/HEAD/CHANGES#Release-511-released-Jul-26-2022) [Compare Source](https://togithub.com/sphinx-doc/sphinx/compare/v5.1.0...v5.1.1) \===================================== ## Bugs fixed - [#​10701](https://togithub.com/sphinx-doc/sphinx/issues/10701): Fix ValueError in the new `deque` based `sphinx.ext.napolean` iterator implementation. - [#​10702](https://togithub.com/sphinx-doc/sphinx/issues/10702): Restore compatability with third-party builders. ### [`v5.1.0`](https://togithub.com/sphinx-doc/sphinx/blob/HEAD/CHANGES#Release-510-released-Jul-24-2022) [Compare Source](https://togithub.com/sphinx-doc/sphinx/compare/v5.0.2...v5.1.0) \===================================== ## Dependencies - [#​10656](https://togithub.com/sphinx-doc/sphinx/issues/10656): Support `Docutils 0.19`\_. Patch by Adam Turner. .. \_Docutils 0.19: https://docutils.sourceforge.io/RELEASE-NOTES.html#release-0-19-2022-07-05 ## Deprecated - [#​10467](https://togithub.com/sphinx-doc/sphinx/issues/10467): Deprecated `sphinx.util.stemmer` in favour of `snowballstemmer`. Patch by Adam Turner. - [#​9856](https://togithub.com/sphinx-doc/sphinx/issues/9856): Deprecated `sphinx.ext.napoleon.iterators`. ## Features added - [#​10444](https://togithub.com/sphinx-doc/sphinx/issues/10444): html theme: Allow specifying multiple CSS files through the `stylesheet` setting in `theme.conf` or by setting `html_style` to an iterable of strings. - [#​10366](https://togithub.com/sphinx-doc/sphinx/issues/10366): std domain: Add support for emphasising placeholders in :rst:dir:`option` directives through a new :confval:`option_emphasise_placeholders` configuration option. - [#​10439](https://togithub.com/sphinx-doc/sphinx/issues/10439): std domain: Use the repr of some variables when displaying warnings, making whitespace issues easier to identify. - [#​10571](https://togithub.com/sphinx-doc/sphinx/issues/10571): quickstart: Reduce content in the generated `conf.py` file. Patch by Pradyun Gedam. - [#​10648](https://togithub.com/sphinx-doc/sphinx/issues/10648): LaTeX: CSS-named-alike additional :ref:`'sphinxsetup' ` keys allow to configure four separate border-widths, four paddings, four corner radii, a shadow (possibly inset), colours for border, background, shadow for each of the code-block, topic, attention, caution, danger, error and warning directives. - [#​10655](https://togithub.com/sphinx-doc/sphinx/issues/10655): LaTeX: Explain non-standard encoding in LatinRules.xdy - [#​10599](https://togithub.com/sphinx-doc/sphinx/issues/10599): HTML Theme: Wrap consecutive footnotes in an `

` element when using Docutils 0.18 or later, to allow for easier styling. This matches the behaviour introduced in Docutils 0.19. Patch by Adam Turner. - [#​10518](https://togithub.com/sphinx-doc/sphinx/issues/10518): config: Add `include_patterns` as the opposite of `exclude_patterns`. Patch by Adam Turner. ## Bugs fixed - [#​10594](https://togithub.com/sphinx-doc/sphinx/issues/10594): HTML Theme: field term colons are doubled if using Docutils 0.18+ - [#​10596](https://togithub.com/sphinx-doc/sphinx/issues/10596): Build failure if Docutils version is 0.18 (not 0.18.1) due to missing `Node.findall()` - [#​10506](https://togithub.com/sphinx-doc/sphinx/issues/10506): LaTeX: build error if highlighting inline code role in figure caption (refs: [#​10251](https://togithub.com/sphinx-doc/sphinx/issues/10251)) - [#​10634](https://togithub.com/sphinx-doc/sphinx/issues/10634): Make -P (pdb) option work better with exceptions triggered from events - [#​10550](https://togithub.com/sphinx-doc/sphinx/issues/10550): py domain: Fix spurious whitespace in unparsing various operators (`+`, `-`, `~`, and `**`). Patch by Adam Turner (refs: [#​10551](https://togithub.com/sphinx-doc/sphinx/issues/10551)). - [#​10460](https://togithub.com/sphinx-doc/sphinx/issues/10460): logging: Always show node source locations as absolute paths. - HTML Search: HTML tags are displayed as a part of object name - HTML Search: search snipets should not be folded - HTML Search: Minor errors are emitted on fetching search snipets - HTML Search: The markers for header links are shown in the search result - [#​10520](https://togithub.com/sphinx-doc/sphinx/issues/10520): HTML Theme: Fix use of sidebar classes in `agogo.css_t`. - [#​6679](https://togithub.com/sphinx-doc/sphinx/issues/6679): HTML Theme: Fix inclusion of hidden toctrees in the agogo theme. - [#​10566](https://togithub.com/sphinx-doc/sphinx/issues/10566): HTML Theme: Fix enable_search_shortcuts does not work - [#​8686](https://togithub.com/sphinx-doc/sphinx/issues/8686): LaTeX: Text can fall out of code-block at end of page and leave artifact on next page - [#​10633](https://togithub.com/sphinx-doc/sphinx/issues/10633): LaTeX: user injected `\color` commands in topic or admonition boxes may cause color leaks in PDF due to upstream `framed.sty `\_ bug - [#​10638](https://togithub.com/sphinx-doc/sphinx/issues/10638): LaTeX: framed coloured boxes in highlighted code (e.g. highlighted diffs using Pygments style `'manni'`) inherit thickness of code-block frame - [#​10647](https://togithub.com/sphinx-doc/sphinx/issues/10647): LaTeX: Only one `\label` is generated for `desc_signature` node even if it has multiple node IDs - [#​10579](https://togithub.com/sphinx-doc/sphinx/issues/10579): i18n: UnboundLocalError is raised on translating raw directive - [#​9577](https://togithub.com/sphinx-doc/sphinx/issues/9577), [#​10088](https://togithub.com/sphinx-doc/sphinx/issues/10088): py domain: Fix warning for duplicate Python references when using `:any:` and autodoc. - [#​10548](https://togithub.com/sphinx-doc/sphinx/issues/10548): HTML Search: fix minor summary issues. ### [`v5.0.2`](https://togithub.com/sphinx-doc/sphinx/blob/HEAD/CHANGES#Release-502-released-Jun-17-2022) [Compare Source](https://togithub.com/sphinx-doc/sphinx/compare/v5.0.1...v5.0.2) \===================================== ## Features added - [#​10523](https://togithub.com/sphinx-doc/sphinx/issues/10523): HTML Theme: Expose the Docutils's version info tuple as a template variable, `docutils_version_info`. Patch by Adam Turner. ## Bugs fixed - [#​10538](https://togithub.com/sphinx-doc/sphinx/issues/10538): autodoc: Inherited class attribute having docstring is documented even if :confval:`autodoc_inherit_docstring` is disabled - [#​10509](https://togithub.com/sphinx-doc/sphinx/issues/10509): autosummary: autosummary fails with a shared library - [#​10497](https://togithub.com/sphinx-doc/sphinx/issues/10497): py domain: Failed to resolve strings in Literal. Patch by Adam Turner. - [#​10523](https://togithub.com/sphinx-doc/sphinx/issues/10523): HTML Theme: Fix double brackets on citation references in Docutils 0.18+. Patch by Adam Turner. - [#​10534](https://togithub.com/sphinx-doc/sphinx/issues/10534): Missing CSS for nav.contents in Docutils 0.18+. Patch by Adam Turner. ### [`v5.0.1`](https://togithub.com/sphinx-doc/sphinx/blob/HEAD/CHANGES#Release-501-released-Jun-03-2022) [Compare Source](https://togithub.com/sphinx-doc/sphinx/compare/v5.0.0...v5.0.1) \===================================== ## Bugs fixed - [#​10498](https://togithub.com/sphinx-doc/sphinx/issues/10498): gettext: TypeError is raised when sorting warning messages if a node has no line number. Patch by Adam Turner. - [#​10493](https://togithub.com/sphinx-doc/sphinx/issues/10493): HTML Theme: :dudir:`topic` directive is rendered incorrectly with Docutils 0.18. Patch by Adam Turner. - [#​10495](https://togithub.com/sphinx-doc/sphinx/issues/10495): IndexError is raised for a :rst:role:`kbd` role having a separator. Patch by Adam Turner. ### [`v5.0.0`](https://togithub.com/sphinx-doc/sphinx/blob/HEAD/CHANGES#Release-500-released-May-30-2022) [Compare Source](https://togithub.com/sphinx-doc/sphinx/compare/v4.5.0...v5.0.0) \===================================== ## Dependencies 5.0.0 b1 - [#​10164](https://togithub.com/sphinx-doc/sphinx/issues/10164): Support `Docutils 0.18`\_. Patch by Adam Turner. .. \_Docutils 0.18: https://docutils.sourceforge.io/RELEASE-NOTES.html#release-0-18-2021-10-26 ## Incompatible changes 5.0.0 b1 - [#​10031](https://togithub.com/sphinx-doc/sphinx/issues/10031): autosummary: `sphinx.ext.autosummary.import_by_name()` now raises `ImportExceptionGroup` instead of `ImportError` when it failed to import target object. Please handle the exception if your extension uses the function to import Python object. As a workaround, you can disable the behavior via `grouped_exception=False` keyword argument until v7.0. - [#​9962](https://togithub.com/sphinx-doc/sphinx/issues/9962): texinfo: Customizing styles of emphasized text via `@definfoenclose` command was not supported because the command was deprecated since texinfo 6.8 - [#​2068](https://togithub.com/sphinx-doc/sphinx/issues/2068): :confval:`intersphinx_disabled_reftypes` has changed default value from an empty list to `['std:doc']` as avoid too surprising silent intersphinx resolutions. To migrate: either add an explicit inventory name to the references intersphinx should resolve, or explicitly set the value of this configuration variable to an empty list. - [#​10197](https://togithub.com/sphinx-doc/sphinx/issues/10197): html theme: Reduce `body_min_width` setting in basic theme to 360px - [#​9999](https://togithub.com/sphinx-doc/sphinx/issues/9999): LaTeX: separate terms from their definitions by a CR (refs: [#​9985](https://togithub.com/sphinx-doc/sphinx/issues/9985)) - [#​10062](https://togithub.com/sphinx-doc/sphinx/issues/10062): Change the default language to `'en'` if any language is not set in `conf.py` 5.0.0 final - [#​10474](https://togithub.com/sphinx-doc/sphinx/issues/10474): :confval:`language` does not accept `None` as it value. The default value of `language` becomes to `'en'` now. Patch by Adam Turner and Takeshi KOMIYA. ## Deprecated 5.0.0 b1 - [#​10028](https://togithub.com/sphinx-doc/sphinx/issues/10028): jQuery and underscore.js will no longer be automatically injected into themes from Sphinx 6.0. If you develop a theme or extension that uses the `jQuery`, `$`, or `$u` global objects, you need to update your JavaScript or use the mitigation below. To re-add jQuery and underscore.js, you will need to copy `jquery.js` and `underscore.js` from `the Sphinx repository`\_ to your `static` directory, and add the following to your `layout.html`: .. \_the Sphinx repository: https://github.com/sphinx-doc/sphinx/tree/v5.3.0/sphinx/themes/basic/static .. code-block:: html+jinja {%- block scripts %} {{ super() }} {%- endblock %} Patch by Adam Turner. - setuptools integration. The `build_sphinx` sub-command for setup.py is marked as deprecated to follow the policy of setuptools team. - The `locale` argument of `sphinx.util.i18n:babel_format_date()` becomes required - The `language` argument of `sphinx.util.i18n:format_date()` becomes required - `sphinx.builders.html.html5_ready` - `sphinx.io.read_doc()` - `sphinx.util.docutils.__version_info__` - `sphinx.util.docutils.is_html5_writer_available()` - `sphinx.writers.latex.LaTeXWriter.docclasses` ## Features added 5.0.0 b1 - [#​9075](https://togithub.com/sphinx-doc/sphinx/issues/9075): autodoc: The default value of :confval:`autodoc_typehints_format` is changed to `'smart'`. It will suppress the leading module names of typehints (ex. `io.StringIO` -> `StringIO`). - [#​8417](https://togithub.com/sphinx-doc/sphinx/issues/8417): autodoc: `:inherited-members:` option now takes multiple classes. It allows to suppress inherited members of several classes on the module at once by specifying the option to :rst:dir:`automodule` directive - [#​9792](https://togithub.com/sphinx-doc/sphinx/issues/9792): autodoc: Add new option for `autodoc_typehints_description_target` to include undocumented return values but not undocumented parameters. - [#​10285](https://togithub.com/sphinx-doc/sphinx/issues/10285): autodoc: singledispatch functions having typehints are not documented - autodoc: :confval:`autodoc_typehints_format` now also applies to attributes, data, properties, and type variable bounds. - [#​10258](https://togithub.com/sphinx-doc/sphinx/issues/10258): autosummary: Recognize a documented attribute of a module as non-imported - [#​10028](https://togithub.com/sphinx-doc/sphinx/issues/10028): Removed internal usages of JavaScript frameworks (jQuery and underscore.js) and modernised `doctools.js` and `searchtools.js` to EMCAScript 2018. Patch by Adam Turner. - [#​10302](https://togithub.com/sphinx-doc/sphinx/issues/10302): C++, add support for conditional expressions (`?:`). - [#​5157](https://togithub.com/sphinx-doc/sphinx/issues/5157), [#​10251](https://togithub.com/sphinx-doc/sphinx/issues/10251): Inline code is able to be highlighted via :dudir:`role` directive - [#​10337](https://togithub.com/sphinx-doc/sphinx/issues/10337): Make sphinx-build faster by caching Publisher object during build. Patch by Adam Turner. ## Bugs fixed 5.0.0 b1 - [#​10200](https://togithub.com/sphinx-doc/sphinx/issues/10200): apidoc: Duplicated submodules are shown for modules having both .pyx and .so files. Patch by Adam Turner and Takeshi KOMIYA. - [#​10279](https://togithub.com/sphinx-doc/sphinx/issues/10279): autodoc: Default values for keyword only arguments in overloaded functions are rendered as a string literal - [#​10280](https://togithub.com/sphinx-doc/sphinx/issues/10280): autodoc: :confval:`autodoc_docstring_signature` unexpectedly generates return value typehint for constructors if docstring has multiple signatures - [#​10266](https://togithub.com/sphinx-doc/sphinx/issues/10266): autodoc: :confval:`autodoc_preserve_defaults` does not work for mixture of keyword only arguments with/without defaults - [#​10310](https://togithub.com/sphinx-doc/sphinx/issues/10310): autodoc: class methods are not documented when decorated with mocked function - [#​10305](https://togithub.com/sphinx-doc/sphinx/issues/10305): autodoc: Failed to extract optional forward-ref'ed typehints correctly via :confval:`autodoc_type_aliases` - [#​10421](https://togithub.com/sphinx-doc/sphinx/issues/10421): autodoc: :confval:`autodoc_preserve_defaults` doesn't work on class methods - [#​10214](https://togithub.com/sphinx-doc/sphinx/issues/10214): html: invalid language tag was generated if :confval:`language` contains a country code (ex. zh_CN) - [#​9974](https://togithub.com/sphinx-doc/sphinx/issues/9974): html: Updated jQuery version from 3.5.1 to 3.6.0 - [#​10236](https://togithub.com/sphinx-doc/sphinx/issues/10236): html search: objects are duplicated in search result - [#​9962](https://togithub.com/sphinx-doc/sphinx/issues/9962): texinfo: Deprecation message for `@definfoenclose` command on bulding texinfo document - [#​10000](https://togithub.com/sphinx-doc/sphinx/issues/10000): LaTeX: glossary terms with common definition are rendered with too much vertical whitespace - [#​10188](https://togithub.com/sphinx-doc/sphinx/issues/10188): LaTeX: alternating multiply referred footnotes produce a `?` in pdf output - [#​10363](https://togithub.com/sphinx-doc/sphinx/issues/10363): LaTeX: make `'howto'` title page rule use `\linewidth` for compatibility with usage of a `twocolumn` class option - [#​10318](https://togithub.com/sphinx-doc/sphinx/issues/10318): `:prepend:` option of :rst:dir:`literalinclude` directive does not work with `:dedent:` option 5.0.0 final - [#​9575](https://togithub.com/sphinx-doc/sphinx/issues/9575): autodoc: The annotation of return value should not be shown when `autodoc_typehints="description"` - [#​9648](https://togithub.com/sphinx-doc/sphinx/issues/9648): autodoc: `*args` and `**kwargs` entries are duplicated when `autodoc_typehints="description"` - [#​8180](https://togithub.com/sphinx-doc/sphinx/issues/8180): autodoc: Docstring metadata ignored for attributes - [#​10443](https://togithub.com/sphinx-doc/sphinx/issues/10443): epub: EPUB builder can't detect the mimetype of .webp file - [#​10104](https://togithub.com/sphinx-doc/sphinx/issues/10104): gettext: Duplicated locations are shown if 3rd party extension does not provide correct information - [#​10456](https://togithub.com/sphinx-doc/sphinx/issues/10456): py domain: `:meta:` fields are displayed if docstring contains two or more meta-field - [#​9096](https://togithub.com/sphinx-doc/sphinx/issues/9096): sphinx-build: the value of progress bar for paralle build is wrong - [#​10110](https://togithub.com/sphinx-doc/sphinx/issues/10110): sphinx-build: exit code is not changed when error is raised on builder-finished event ### [`v4.5.0`](https://togithub.com/sphinx-doc/sphinx/blob/HEAD/CHANGES#Release-450-released-Mar-28-2022) [Compare Source](https://togithub.com/sphinx-doc/sphinx/compare/v4.4.0...v4.5.0) \===================================== ## Incompatible changes - [#​10112](https://togithub.com/sphinx-doc/sphinx/issues/10112): extlinks: Disable hardcoded links detector by default - [#​9993](https://togithub.com/sphinx-doc/sphinx/issues/9993), [#​10177](https://togithub.com/sphinx-doc/sphinx/issues/10177): std domain: Disallow to refer an inline target via :rst:role:`ref` role ## Deprecated - `sphinx.ext.napoleon.docstring.GoogleDocstring._qualify_name()` ## Features added - [#​10260](https://togithub.com/sphinx-doc/sphinx/issues/10260): Enable `FORCE_COLOR` and `NO_COLOR` for terminal colouring - [#​10234](https://togithub.com/sphinx-doc/sphinx/issues/10234): autosummary: Add "autosummary" CSS class to summary tables - [#​10125](https://togithub.com/sphinx-doc/sphinx/issues/10125): extlinks: Improve suggestion message for a reference having title - [#​10112](https://togithub.com/sphinx-doc/sphinx/issues/10112): extlinks: Add :confval:`extlinks_detect_hardcoded_links` to enable hardcoded links detector feature - [#​9494](https://togithub.com/sphinx-doc/sphinx/issues/9494), [#​9456](https://togithub.com/sphinx-doc/sphinx/issues/9456): html search: Add a config variable :confval:`html_show_search_summary` to enable/disable the search summaries - [#​9337](https://togithub.com/sphinx-doc/sphinx/issues/9337): HTML theme, add option `enable_search_shortcuts` that enables :kbd:`/` as a Quick search shortcut and :kbd:`Esc` shortcut that removes search highlighting. - [#​10107](https://togithub.com/sphinx-doc/sphinx/issues/10107): i18n: Allow to suppress translation warnings by adding `#noqa` comment to the tail of each translation message - [#​10252](https://togithub.com/sphinx-doc/sphinx/issues/10252): C++, support attributes on classes, unions, and enums. - [#​10253](https://togithub.com/sphinx-doc/sphinx/issues/10253): :rst:role:`pep` role now generates URLs based on `peps.python.org `\_ ## Bugs fixed - [#​9876](https://togithub.com/sphinx-doc/sphinx/issues/9876): autodoc: Failed to document an imported class that is built from native binary module - [#​10133](https://togithub.com/sphinx-doc/sphinx/issues/10133): autodoc: Crashed when mocked module is used for type annotation - [#​10146](https://togithub.com/sphinx-doc/sphinx/issues/10146): autodoc: :confval:`autodoc_default_options` does not support `no-value` option - [#​9971](https://togithub.com/sphinx-doc/sphinx/issues/9971): autodoc: TypeError is raised when the target object is annotated by unhashable object - [#​10205](https://togithub.com/sphinx-doc/sphinx/issues/10205): extlinks: Failed to compile regexp on checking hardcoded links - [#​10277](https://togithub.com/sphinx-doc/sphinx/issues/10277): html search: Could not search short words (ex. "use") - [#​9529](https://togithub.com/sphinx-doc/sphinx/issues/9529): LaTeX: named auto numbered footnote (ex. `[#named]`) that is referred multiple times was rendered to a question mark - [#​9924](https://togithub.com/sphinx-doc/sphinx/issues/9924): LaTeX: multi-line :rst:dir:`cpp:function` directive has big vertical spacing in Latexpdf - [#​10158](https://togithub.com/sphinx-doc/sphinx/issues/10158): LaTeX: excessive whitespace since v4.4.0 for undocumented variables/structure members - [#​10175](https://togithub.com/sphinx-doc/sphinx/issues/10175): LaTeX: named footnote reference is linked to an incorrect footnote if the name is also used in the different document - [#​10269](https://togithub.com/sphinx-doc/sphinx/issues/10269): manpage: Failed to resolve the title of :rst:role:`ref` cross references - [#​10179](https://togithub.com/sphinx-doc/sphinx/issues/10179): i18n: suppress "rST localization" warning - [#​10118](https://togithub.com/sphinx-doc/sphinx/issues/10118): imgconverter: Unnecessary availablity check is called for remote URIs - [#​10181](https://togithub.com/sphinx-doc/sphinx/issues/10181): napoleon: attributes are displayed like class attributes for google style docstrings when :confval:`napoleon_use_ivar` is enabled - [#​10122](https://togithub.com/sphinx-doc/sphinx/issues/10122): sphinx-build: make.bat does not check the installation of sphinx-build command before showing help ### [`v4.4.0`](https://togithub.com/sphinx-doc/sphinx/blob/HEAD/CHANGES#Release-440-released-Jan-17-2022) [Compare Source](https://togithub.com/sphinx-doc/sphinx/compare/v4.3.2...v4.4.0) \===================================== ## Dependencies - [#​10007](https://togithub.com/sphinx-doc/sphinx/issues/10007): Use `importlib_metadata` for python-3.9 or older - [#​10007](https://togithub.com/sphinx-doc/sphinx/issues/10007): Drop `setuptools` ## Features added - [#​9075](https://togithub.com/sphinx-doc/sphinx/issues/9075): autodoc: Add a config variable :confval:`autodoc_typehints_format` to suppress the leading module names of typehints of function signatures (ex. `io.StringIO` -> `StringIO`) - [#​9831](https://togithub.com/sphinx-doc/sphinx/issues/9831): Autosummary now documents only the members specified in a module's `__all__` attribute if :confval:`autosummary_ignore_module_all` is set to `False`. The default behaviour is unchanged. Autogen also now supports this behavior with the `--respect-module-all` switch. - [#​9555](https://togithub.com/sphinx-doc/sphinx/issues/9555): autosummary: Improve error messages on failure to load target object - [#​9800](https://togithub.com/sphinx-doc/sphinx/issues/9800): extlinks: Emit warning if a hardcoded link is replaceable by an extlink, suggesting a replacement. - [#​9961](https://togithub.com/sphinx-doc/sphinx/issues/9961): html: Support nested HTML elements in other HTML builders - [#​10013](https://togithub.com/sphinx-doc/sphinx/issues/10013): html: Allow to change the loading method of JS via `loading_method` parameter for :meth:`.Sphinx.add_js_file()` - [#​9551](https://togithub.com/sphinx-doc/sphinx/issues/9551): html search: "Hide Search Matches" link removes "highlight" parameter from URL - [#​9815](https://togithub.com/sphinx-doc/sphinx/issues/9815): html theme: Wrap sidebar components in div to allow customizing their layout via CSS - [#​9827](https://togithub.com/sphinx-doc/sphinx/issues/9827): i18n: Sort items in glossary by translated terms - [#​9899](https://togithub.com/sphinx-doc/sphinx/issues/9899): py domain: Allows to specify cross-reference specifier (`.` and `~`) as `:type:` option - [#​9894](https://togithub.com/sphinx-doc/sphinx/issues/9894): linkcheck: add option `linkcheck_exclude_documents` to disable link checking in matched documents. - [#​9793](https://togithub.com/sphinx-doc/sphinx/issues/9793): sphinx-build: Allow to use the parallel build feature in macOS on macOS and Python3.8+ - [#​10055](https://togithub.com/sphinx-doc/sphinx/issues/10055): sphinx-build: Create directories when `-w` option given - [#​9993](https://togithub.com/sphinx-doc/sphinx/issues/9993): std domain: Allow to refer an inline target (ex. \`\`\_`target name```) via :rst:role:`ref\` role - [#​9981](https://togithub.com/sphinx-doc/sphinx/issues/9981): std domain: Strip value part of the option directive from general index - [#​9391](https://togithub.com/sphinx-doc/sphinx/issues/9391): texinfo: improve variable in `samp` role - [#​9578](https://togithub.com/sphinx-doc/sphinx/issues/9578): texinfo: Add :confval:`texinfo_cross_references` to disable cross references for readability with standalone readers - [#​9822](https://togithub.com/sphinx-doc/sphinx/issues/9822) (and [#​9062](https://togithub.com/sphinx-doc/sphinx/issues/9062)), add new Intersphinx role :rst:role:`external` for explict lookup in the external projects, without resolving to the local project. ## Bugs fixed - [#​9866](https://togithub.com/sphinx-doc/sphinx/issues/9866): autodoc: doccomment for the imported class was ignored - [#​9883](https://togithub.com/sphinx-doc/sphinx/issues/9883): autodoc: doccomment for the alias to mocked object was ignored - [#​9908](https://togithub.com/sphinx-doc/sphinx/issues/9908): autodoc: debug message is shown on building document using NewTypes with Python 3.10 - [#​9968](https://togithub.com/sphinx-doc/sphinx/issues/9968): autodoc: instance variables are not shown if **init** method has position-only-arguments - [#​9194](https://togithub.com/sphinx-doc/sphinx/issues/9194): autodoc: types under the "typing" module are not hyperlinked - [#​10009](https://togithub.com/sphinx-doc/sphinx/issues/10009): autodoc: Crashes if target object raises an error on getting docstring - [#​10058](https://togithub.com/sphinx-doc/sphinx/issues/10058): autosummary: Imported members are not shown when `autodoc_class_signature = 'separated'` - [#​9947](https://togithub.com/sphinx-doc/sphinx/issues/9947): i18n: topic directive having a bullet list can't be translatable - [#​9878](https://togithub.com/sphinx-doc/sphinx/issues/9878): mathjax: MathJax configuration is placed after loading MathJax itself - [#​9932](https://togithub.com/sphinx-doc/sphinx/issues/9932): napoleon: empty "returns" section is generated even if no description - [#​9857](https://togithub.com/sphinx-doc/sphinx/issues/9857): Generated RFC links use outdated base url - [#​9909](https://togithub.com/sphinx-doc/sphinx/issues/9909): HTML, prevent line-wrapping in literal text. - [#​10061](https://togithub.com/sphinx-doc/sphinx/issues/10061): html theme: Configuration values added by themes are not be able to override from conf.py - [#​10073](https://togithub.com/sphinx-doc/sphinx/issues/10073): imgconverter: Unnecessary availablity check is called for "data" URIs - [#​9925](https://togithub.com/sphinx-doc/sphinx/issues/9925): LaTeX: prohibit also with `'xelatex'` line splitting at dashes of inline and parsed literals - [#​9944](https://togithub.com/sphinx-doc/sphinx/issues/9944): LaTeX: extra vertical whitespace for some nested declarations - [#​9940](https://togithub.com/sphinx-doc/sphinx/issues/9940): LaTeX: Multi-function declaration in Python domain has cramped vertical spacing in latexpdf output - [#​10015](https://togithub.com/sphinx-doc/sphinx/issues/10015): py domain: types under the "typing" module are not hyperlinked defined at info-field-list - [#​9390](https://togithub.com/sphinx-doc/sphinx/issues/9390): texinfo: Do not emit labels inside footnotes - [#​9413](https://togithub.com/sphinx-doc/sphinx/issues/9413): xml: Invalid XML was generated when cross referencing python objects - [#​9979](https://togithub.com/sphinx-doc/sphinx/issues/9979): Error level messages were displayed as warning messages - [#​10057](https://togithub.com/sphinx-doc/sphinx/issues/10057): Failed to scan documents if the project is placed onto the root directory - [#​9636](https://togithub.com/sphinx-doc/sphinx/issues/9636): code-block: `:dedent:` without argument did strip newlines ### [`v4.3.2`](https://togithub.com/sphinx-doc/sphinx/blob/HEAD/CHANGES#Release-432-released-Dec-19-2021) [Compare Source](https://togithub.com/sphinx-doc/sphinx/compare/v4.3.1...v4.3.2) \===================================== ## Bugs fixed - [#​9917](https://togithub.com/sphinx-doc/sphinx/issues/9917): C and C++, parse fundamental types no matter the order of simple type specifiers. ### [`v4.3.1`](https://togithub.com/sphinx-doc/sphinx/blob/HEAD/CHANGES#Release-431-released-Nov-28-2021) [Compare Source](https://togithub.com/sphinx-doc/sphinx/compare/v4.3.0...v4.3.1) \===================================== ## Features added - [#​9864](https://togithub.com/sphinx-doc/sphinx/issues/9864): mathjax: Support chnaging the loading method of MathJax to "defer" via :confval:`mathjax_options` ## Bugs fixed - [#​9838](https://togithub.com/sphinx-doc/sphinx/issues/9838): autodoc: AttributeError is raised on building document for functions decorated by functools.lru_cache - [#​9879](https://togithub.com/sphinx-doc/sphinx/issues/9879): autodoc: AttributeError is raised on building document for an object having invalid **doc** attribute - [#​9844](https://togithub.com/sphinx-doc/sphinx/issues/9844): autodoc: Failed to process a function wrapped with functools.partial if :confval:`autodoc_preserve_defaults` enabled - [#​9872](https://togithub.com/sphinx-doc/sphinx/issues/9872): html: Class namespace collision between autodoc signatures and docutils-0.17 - [#​9868](https://togithub.com/sphinx-doc/sphinx/issues/9868): imgmath: Crashed if the dvisvgm command failed to convert equation - [#​9864](https://togithub.com/sphinx-doc/sphinx/issues/9864): mathjax: Failed to render equations via MathJax v2. The loading method of MathJax is back to "async" method again ### [`v4.3.0`](https://togithub.com/sphinx-doc/sphinx/blob/HEAD/CHANGES#Release-430-released-Nov-11-2021) [Compare Source](https://togithub.com/sphinx-doc/sphinx/compare/v4.2.0...v4.3.0) \===================================== ## Dependencies - Support Python 3.10 ## Incompatible changes - [#​9649](https://togithub.com/sphinx-doc/sphinx/issues/9649): `searchindex.js`: the embedded data has changed format to allow objects with the same name in different domains. - [#​9672](https://togithub.com/sphinx-doc/sphinx/issues/9672): The rendering of Python domain declarations is implemented with more docutils nodes to allow better CSS styling. It may break existing styling. - [#​9672](https://togithub.com/sphinx-doc/sphinx/issues/9672): the signature of `domains.python.PyObject.get_signature_prefix` has changed to return a list of nodes instead of a plain string. - [#​9695](https://togithub.com/sphinx-doc/sphinx/issues/9695): `domains.js.JSObject.display_prefix` has been changed into a method `get_display_prefix` which now returns a list of nodes instead of a plain string. - [#​9695](https://togithub.com/sphinx-doc/sphinx/issues/9695): The rendering of Javascript domain declarations is implemented with more docutils nodes to allow better CSS styling. It may break existing styling. - [#​9450](https://togithub.com/sphinx-doc/sphinx/issues/9450): mathjax: Load MathJax via "defer" strategy ## Deprecated - `sphinx.ext.autodoc.AttributeDocumenter._datadescriptor` - `sphinx.writers.html.HTMLTranslator._fieldlist_row_index` - `sphinx.writers.html.HTMLTranslator._table_row_index` - `sphinx.writers.html5.HTML5Translator._fieldlist_row_index` - `sphinx.writers.html5.HTML5Translator._table_row_index` ## Features added - [#​9639](https://togithub.com/sphinx-doc/sphinx/issues/9639): autodoc: Support asynchronous generator functions - [#​9664](https://togithub.com/sphinx-doc/sphinx/issues/9664): autodoc: `autodoc-process-bases` supports to inject reST snippet as a base class - [#​9691](https://togithub.com/sphinx-doc/sphinx/issues/9691): C, added new info-field `retval` for :rst:dir:`c:function` and :rst:dir:`c:macro`. - C++, added new info-field `retval` for :rst:dir:`cpp:function`. - [#​9618](https://togithub.com/sphinx-doc/sphinx/issues/9618): i18n: Add :confval:`gettext_allow_fuzzy_translations` to allow "fuzzy" messages for translation - [#​9672](https://togithub.com/sphinx-doc/sphinx/issues/9672): More CSS classes on Python domain descriptions - [#​9695](https://togithub.com/sphinx-doc/sphinx/issues/9695): More CSS classes on Javascript domain descriptions - [#​9683](https://togithub.com/sphinx-doc/sphinx/issues/9683): Revert the removal of `add_stylesheet()` API. It will be kept until the Sphinx 6.0 release - [#​2068](https://togithub.com/sphinx-doc/sphinx/issues/2068), add :confval:`intersphinx_disabled_reftypes` for disabling interphinx resolution of cross-references that do not have an explicit inventory specification. Specific types of cross-references can be disabled, e.g., `std:doc` or all cross-references in a specific domain, e.g., `std:*`. - [#​9623](https://togithub.com/sphinx-doc/sphinx/issues/9623): Allow to suppress "toctree contains reference to excluded document" warnings using :confval:`suppress_warnings` ## Bugs fixed - [#​9630](https://togithub.com/sphinx-doc/sphinx/issues/9630): autodoc: Failed to build cross references if :confval:`primary_domain` is not 'py' - [#​9644](https://togithub.com/sphinx-doc/sphinx/issues/9644): autodoc: Crashed on getting source info from problematic object - [#​9655](https://togithub.com/sphinx-doc/sphinx/issues/9655): autodoc: mocked object having doc comment is warned unexpectedly - [#​9651](https://togithub.com/sphinx-doc/sphinx/issues/9651): autodoc: return type field is not generated even if :confval:`autodoc_typehints_description_target` is set to "documented" when its info-field-list contains `:returns:` field - [#​9657](https://togithub.com/sphinx-doc/sphinx/issues/9657): autodoc: The base class for a subclass of mocked object is incorrect - [#​9607](https://togithub.com/sphinx-doc/sphinx/issues/9607): autodoc: Incorrect base class detection for the subclasses of the generic class - [#​9755](https://togithub.com/sphinx-doc/sphinx/issues/9755): autodoc: memory addresses are shown for aliases - [#​9752](https://togithub.com/sphinx-doc/sphinx/issues/9752): autodoc: Failed to detect type annotation for slots attribute - [#​9756](https://togithub.com/sphinx-doc/sphinx/issues/9756): autodoc: Crashed if classmethod does not have **func** attribute - [#​9757](https://togithub.com/sphinx-doc/sphinx/issues/9757): autodoc: :confval:`autodoc_inherit_docstrings` does not effect to overridden classmethods - [#​9781](https://togithub.com/sphinx-doc/sphinx/issues/9781): autodoc: :confval:`autodoc_preserve_defaults` does not support hexadecimal numeric - [#​9630](https://togithub.com/sphinx-doc/sphinx/issues/9630): autosummary: Failed to build summary table if :confval:`primary_domain` is not 'py' - [#​9670](https://togithub.com/sphinx-doc/sphinx/issues/9670): html: Fix download file with special characters - [#​9710](https://togithub.com/sphinx-doc/sphinx/issues/9710): html: Wrong styles for even/odd rows in nested tables - [#​9763](https://togithub.com/sphinx-doc/sphinx/issues/9763): html: parameter name and its type annotation are not separated in HTML - [#​9649](https://togithub.com/sphinx-doc

---

Configuration

📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 Ignore: Close this PR and you won't be reminded about this update again.

---

• [ ] If you want to rebase/retry this PR, check this box

---

This PR has been generated by Mend Renovate. View repository job log here.

[what-the-diff[bot]]

PR Summary

• Sphinx Version Update The version of Sphinx, a documentation generation tool, has been updated from 4.0 to 7.1 to take advantage of the latest features and improvements.

[github-actions[bot]]

Since this pull request has not had any activity within the last 5 days, I have marked it as stale. I will close it if no further activity occurs within the next 5 days.

[renovate[bot]]

Renovate Ignore Notification

Because you closed this PR without merging, Renovate will ignore this update. You will not get PRs for any future 7.x releases. But if you manually upgrade to 7.x then Renovate will re-enable minor and patch updates automatically.

If you accidentally closed this PR, or if you changed your mind: rename this PR to get a fresh replacement PR.