feat(deps): update dependency sphinx to v8

[renovate[bot]]

This PR contains the following updates:

Package	Change	Age	Adoption	Passing	Confidence
Sphinx (changelog)	^7.0.0 -> ^8.0.0

---

Release Notes

sphinx-doc/sphinx (Sphinx)

### [`v8.1.3`](https://redirect.github.com/sphinx-doc/sphinx/releases/tag/v8.1.3): Sphinx 8.1.3 [Compare Source](https://redirect.github.com/sphinx-doc/sphinx/compare/v8.1.2...v8.1.3) Changelog: https://www.sphinx-doc.org/en/master/changes/8.1.html ## Bugs fixed - [#​13013](https://redirect.github.com/sphinx-doc/sphinx/issues/13013): Restore support for `cut_lines()` with no object type. Patch by Adam Turner. ### [`v8.1.2`](https://redirect.github.com/sphinx-doc/sphinx/releases/tag/v8.1.2): Sphinx 8.1.2 [Compare Source](https://redirect.github.com/sphinx-doc/sphinx/compare/v8.1.1...v8.1.2) Changelog: https://www.sphinx-doc.org/en/master/changes.html ## Bugs fixed - [#​13012](https://redirect.github.com/sphinx-doc/sphinx/issues/13012): Expose `sphinx.errors.ExtensionError` in `sphinx.util` for backwards compatibility. This will be removed in Sphinx 9, as exposing the exception in `sphinx.util` was never intentional. `ExtensionError` has been part of `sphinx.errors` since Sphinx 0.9. Patch by Adam Turner. ### [`v8.1.1`](https://redirect.github.com/sphinx-doc/sphinx/releases/tag/v8.1.1): Sphinx 8.1.1 [Compare Source](https://redirect.github.com/sphinx-doc/sphinx/compare/v8.1.0...v8.1.1) Changelog: https://www.sphinx-doc.org/en/master/changes.html ## Bugs fixed - [#​13006](https://redirect.github.com/sphinx-doc/sphinx/issues/13006): Use the preferred https://www.cve.org/ URL for the `:cve:` role. Patch by Hugo van Kemenade. - [#​13007](https://redirect.github.com/sphinx-doc/sphinx/issues/13007): LaTeX: Improve resiliency when the required `fontawesome` or `fontawesome5` packages are not installed. Patch by Jean-François B. ### [`v8.1.0`](https://redirect.github.com/sphinx-doc/sphinx/blob/HEAD/CHANGES.rst#Release-810-released-Oct-10-2024) [Compare Source](https://redirect.github.com/sphinx-doc/sphinx/compare/v8.0.2...v8.1.0) \===================================== ## Dependencies - [#​12756](https://redirect.github.com/sphinx-doc/sphinx/issues/12756): Add lower-bounds to the `sphinxcontrib-*` dependencies. Patch by Adam Turner. - [#​12833](https://redirect.github.com/sphinx-doc/sphinx/issues/12833): Update the LaTeX `parskip` package from 2001 to 2018. Patch by Jean-François B. ## Incompatible changes - [#​12763](https://redirect.github.com/sphinx-doc/sphinx/issues/12763): Remove unused internal class `sphinx.util.Tee`. Patch by Adam Turner. - [#​12822](https://redirect.github.com/sphinx-doc/sphinx/issues/12822): LaTeX: for Unicode engines, the :ref:`fvset` default is changed to `'\\fvset{fontsize=auto}'` from `'\\fvset{fontsize=\\small}'`. Code-blocks are unchanged as FreeMono is now loaded with `Scale=0.9`. An adjustment to existing projects is needed only if they used a custom :ref:`fontpkg` configuration and did not set :ref:`fvset`. Patch by Jean-François B. - [#​12875](https://redirect.github.com/sphinx-doc/sphinx/issues/12875): Disable smartquotes for languages: `zh_CN` and `zh_TW` by default. Patch by A. Rafey Khan. ## Deprecated - [#​12762](https://redirect.github.com/sphinx-doc/sphinx/issues/12762): Deprecate `sphinx.util.import_object`. Use :py:func:`importlib.import_module` instead. Patch by Adam Turner. - [#​12766](https://redirect.github.com/sphinx-doc/sphinx/issues/12766): Deprecate `sphinx.util.FilenameUniqDict` and `sphinx.util.DownloadFiles`. Patch by Adam Turner. ## Features added - [#​11328](https://redirect.github.com/sphinx-doc/sphinx/issues/11328): Mention evaluation of templated content during production of static output files. Patch by James Addison. - [#​12704](https://redirect.github.com/sphinx-doc/sphinx/issues/12704): LaTeX: make :dudir:`contents `, :dudir:`topic`, and :dudir:`sidebar` directives separately customizable for PDF output. Patch by Jean-François B. and Bénédikt Tran. - [#​12474](https://redirect.github.com/sphinx-doc/sphinx/issues/12474): Support type-dependent search result highlighting via CSS. Patch by Tim Hoffmann. - [#​12652](https://redirect.github.com/sphinx-doc/sphinx/issues/12652): LaTeX: Add :confval:`math_numsep` support to latex builder. Patch by Thomas Fanning and Jean-François B. - [#​12743](https://redirect.github.com/sphinx-doc/sphinx/issues/12743): No longer exit on the first warning when :option:`--fail-on-warning ` is used. Instead, exit with a non-zero status if any warnings were generated during the build. Patch by Adam Turner. - [#​12743](https://redirect.github.com/sphinx-doc/sphinx/issues/12743): Add :option:`sphinx-build --exception-on-warning`, to raise an exception when warnings are emitted during the build. Patch by Adam Turner and Jeremy Maitin-Shepard. - [#​12907](https://redirect.github.com/sphinx-doc/sphinx/issues/12907): Add :confval:`html_last_updated_use_utc` to allow using universal time (GMT/UTC) instead of local time for the date-time supplied to :confval:`html_last_updated_fmt`. Patch by Adam Turner. - [#​12910](https://redirect.github.com/sphinx-doc/sphinx/issues/12910): Copyright entries now support the `'%Y'` placeholder to substitute the current year. This is helpful for reducing the reliance on Python modules such as :py:mod:`time` or :py:mod:`datetime` in :file:`conf.py`. See :ref:`the docs ` for further detail. Patch by Adam Turner. - [#​11781](https://redirect.github.com/sphinx-doc/sphinx/issues/11781): Add roles for referencing CVEs (:rst:role:`:cve: `) and CWEs (:rst:role:`:cwe: `). Patch by Hugo van Kemenade. - [#​11809](https://redirect.github.com/sphinx-doc/sphinx/issues/11809): Improve the formatting for RFC section anchors. Patch by Jakub Stasiak and Adam Turner. - [#​12852](https://redirect.github.com/sphinx-doc/sphinx/issues/12852): Support a :attr:`.Builder.supported_linkcode` attribute for builders to enable use of :mod:`sphinx.ext.linkcode`-generated references. Patch by James Knight. - [#​12949](https://redirect.github.com/sphinx-doc/sphinx/issues/12949): Print configuration options that differ from the pickled environment. This can be helpful in diagnosing the cause of a full rebuild. Patch by Adam Turner. ## Bugs fixed - [#​12514](https://redirect.github.com/sphinx-doc/sphinx/issues/12514): intersphinx: fix the meaning of a negative value for :confval:`intersphinx_cache_limit`. Patch by Shengyu Zhang. - [#​12722](https://redirect.github.com/sphinx-doc/sphinx/issues/12722): LaTeX: avoid TeX reporting `Overfull \hbox` from too long strings in a codeline when the problem has actually been solved thanks to :ref:`latexsphinxsetupforcewraps`. Patch by Jean-François B. - [#​12730](https://redirect.github.com/sphinx-doc/sphinx/issues/12730): The `UnreferencedFootnotesDetector` transform has been improved to more consistently detect unreferenced footnotes. Note, the priority of the transform has been changed from 200 to 622, so that it now runs after the docutils `Footnotes` resolution transform. Patch by Chris Sewell. - [#​12778](https://redirect.github.com/sphinx-doc/sphinx/issues/12778): LaTeX: let :ref:`'sphinxsetup' ` `div.topic_box-shadow` key if used with only one dimension set both x-offset and y-offset as per documentation. Patch by Jean-François B. - [#​12587](https://redirect.github.com/sphinx-doc/sphinx/issues/12587): Do not warn when potential ambiguity detected during Intersphinx resolution occurs due to duplicate targets that differ case-insensitively. Patch by James Addison. - [#​12639](https://redirect.github.com/sphinx-doc/sphinx/issues/12639): Fix singular and plural search results text. Patch by Hugo van Kemenade. - [#​12645](https://redirect.github.com/sphinx-doc/sphinx/issues/12645): Correctly support custom gettext output templates. Patch by Jeremy Bowman. - [#​12717](https://redirect.github.com/sphinx-doc/sphinx/issues/12717): LaTeX: let :option:`-q ` (quiet) option for :program:`sphinx-build -M latexpdf` or :program:`make latexpdf` (`O=-q`) get passed to :program:`latexmk`. Let :option:`-Q ` (silent) apply as well to the PDF build phase. Patch by Jean-François B. - [#​12744](https://redirect.github.com/sphinx-doc/sphinx/issues/12744): LaTeX: Classes injected by a custom interpreted text role now give rise to nested `\DUrole`'s, rather than a single one with comma separated classes. Patch by Jean-François B. - [#​12831](https://redirect.github.com/sphinx-doc/sphinx/issues/12831): LaTeX: avoid large voids sometimes occurring at page bottoms. Patch by Jean-François B. - [#​11970](https://redirect.github.com/sphinx-doc/sphinx/issues/11970), [#​12551](https://redirect.github.com/sphinx-doc/sphinx/issues/12551): singlehtml builder: make target URIs to be same-document references in the sense of :rfc:`RFC 3986, §4.4 <3986#section-4.4>`, e.g., `index.html#foo` becomes `#foo`. (note: continuation of a partial fix added in Sphinx 7.3.0) Patch by James Addison (with reference to prior work by Eric Norige). - [#​12735](https://redirect.github.com/sphinx-doc/sphinx/issues/12735): Fix :pep:`695` generic classes LaTeX output formatting. Patch by Jean-François B. and Bénédikt Tran. - [#​12782](https://redirect.github.com/sphinx-doc/sphinx/issues/12782): intersphinx: fix double forward slashes when generating the inventory file URL (user-defined base URL of an intersphinx project are left untouched even if they end with double forward slashes). Patch by Bénédikt Tran. - [#​12796](https://redirect.github.com/sphinx-doc/sphinx/issues/12796): Enable parallel reading if requested, even if there are fewer than 6 documents. Patch by Matthias Geier. - [#​12844](https://redirect.github.com/sphinx-doc/sphinx/issues/12844): Restore support for `:noindex:` for the :rst:dir:`js:module` and :rst:dir:`py:module` directives. Patch by Stephen Finucane. - [#​12916](https://redirect.github.com/sphinx-doc/sphinx/issues/12916): Restore support for custom templates named with the legacy `_t` suffix during `apidoc` RST rendering (regression in 7.4.0). Patch by James Addison. - [#​12451](https://redirect.github.com/sphinx-doc/sphinx/issues/12451): Only substitute copyright notice years with values from `SOURCE_DATE_EPOCH` for entries that match the current system clock year, and disallow substitution of future years. Patch by James Addison and Adam Turner. - [#​12905](https://redirect.github.com/sphinx-doc/sphinx/issues/12905): intersphinx: fix flipped use of :confval:`intersphinx_cache_limit`, which always kept the cache for positive values, and always refreshed it for negative ones. Patch by Nico Madysa. - [#​12888](https://redirect.github.com/sphinx-doc/sphinx/issues/12888): Add a warning when document is included in multiple toctrees and ensure deterministic resolution of global toctree in parallel builds by choosing the lexicographically greatest parent document. Patch by A. Rafey Khan - [#​12995](https://redirect.github.com/sphinx-doc/sphinx/issues/12995): Significantly improve performance when building the search index for Chinese languages. Patch by Adam Turner. - [#​12767](https://redirect.github.com/sphinx-doc/sphinx/issues/12767): :py:meth:`.Builder.write` is typed as `final`, meaning that the :event:`write-started` event may be relied upon by extensions. A new :py:meth:`.Builder.write_documents` method has been added to control how documents are written. This is intended for builders that do not output a file for each document. Patch by Adam Turner. ## Testing - [#​12141](https://redirect.github.com/sphinx-doc/sphinx/issues/12141): Migrate from the deprecated `karma` JavaScript test framework to the actively-maintained `jasmine` framework. Test coverage is unaffected. Patch by James Addison. ### [`v8.0.2`](https://redirect.github.com/sphinx-doc/sphinx/releases/tag/v8.0.2): Sphinx 8.0.2 [Compare Source](https://redirect.github.com/sphinx-doc/sphinx/compare/v8.0.1...v8.0.2) Changelog: https://www.sphinx-doc.org/en/master/changes.html ### [`v8.0.1`](https://redirect.github.com/sphinx-doc/sphinx/releases/tag/v8.0.1): Sphinx 8.0.1 [Compare Source](https://redirect.github.com/sphinx-doc/sphinx/compare/v8.0.0...v8.0.1) Changelog: https://www.sphinx-doc.org/en/master/changes.html ### [`v8.0.0`](https://redirect.github.com/sphinx-doc/sphinx/releases/tag/v8.0.0): Sphinx 8.0.0 [Compare Source](https://redirect.github.com/sphinx-doc/sphinx/compare/v7.4.7...v8.0.0) Changelog: https://www.sphinx-doc.org/en/master/changes.html ## Dependencies - [#​12633](https://redirect.github.com/sphinx-doc/sphinx/issues/12633): Drop Python 3.9 support. ## Incompatible changes - Remove deprecated functions from `sphinx.util`: - Removed `sphinx.util.path_stabilize` (use `sphinx.util.osutil.path_stabilize`). - Removed `sphinx.util.display_chunk` (use `sphinx.util.display.display_chunk`). - Removed `sphinx.util.status_iterator` (use `sphinx.util.display.status_iterator`). - Removed `sphinx.util.SkipProgressMessage` (use `sphinx.util.display.SkipProgressMessage`). - Removed `sphinx.util.progress_message` (use `sphinx.util.display.progress_message`). - Removed `sphinx.util.epoch_to_rfc1123` (use `sphinx.http_date.epoch_to_rfc1123`). - Removed `sphinx.util.rfc1123_to_epoch` (use `sphinx.http_date.rfc1123_to_epoch`). - Removed `sphinx.util.save_traceback` (use `sphinx.exceptions.save_traceback`). - Removed `sphinx.util.format_exception_cut_frames` (use `sphinx.exceptions.format_exception_cut_frames`). - Removed `sphinx.util.xmlname_checker` (use `sphinx.builders.epub3._XML_NAME_PATTERN`). Patch by Adam Turner. - Removed `sphinx.util.osutil.cd` (use `contextlib.chdir`). Patch by Adam Turner. - Removed `sphinx.util.typing.stringify` (use `sphinx.util.typing.stringify_annotation`). Patch by Adam Turner. - [#​12593](https://redirect.github.com/sphinx-doc/sphinx/issues/12593): Raise an error for invalid `html_sidebars` values. Patch by Adam Turner. - [#​12593](https://redirect.github.com/sphinx-doc/sphinx/issues/12593): Raise an error in `Theme.get_config` for invalid sections. Patch by Adam Turner. - [#​11693](https://redirect.github.com/sphinx-doc/sphinx/issues/11693): Remove support for old-style `Makefile` and `make.bat` output in `sphinx-quickstart`. - [#​11693](https://redirect.github.com/sphinx-doc/sphinx/issues/11693): Remove the `--no-use-make-mode`, `-M`, `--use-make-mode`, and `-m` options from `sphinx-quickstart`. Patch by Adam Turner. - Removed the tuple interface to `sphinx.ext.autodoc.ObjectMember`. Patch by Adam Turner. - [#​12630](https://redirect.github.com/sphinx-doc/sphinx/issues/12630): Sphinx 8 makes two changes to the `linkcheck` configuration defaults: - `linkcheck_allow_unauthorized` is now `False` by default. - `linkcheck_report_timeouts_as_broken` is now `False` by default. Patch by James Addison. - [#​12597](https://redirect.github.com/sphinx-doc/sphinx/issues/12597): Change the default of `show_warning_types` from `False` to `True`. Patch by Chris Sewell. - [#​12083](https://redirect.github.com/sphinx-doc/sphinx/issues/12083): Remove support for the old (2008--2010) Sphinx 0.5 and Sphinx 0.6 `intersphinx_mapping` format. Patch by Bénédikt Tran and Adam Turner. - [#​12096](https://redirect.github.com/sphinx-doc/sphinx/issues/12096): Do not overwrite user-supplied files when copying assets unless forced with `force=True`. Patch by Adam Turner. - [#​12646](https://redirect.github.com/sphinx-doc/sphinx/issues/12646): Remove `sphinx.util.inspect.isNewType`. Use `isinstance(obj, typing.NewType)` instead on Python 3.10 and newer. Patch by Adam Turner. - Remove the long-deprecated (since Sphinx 2) alias to `VersionChange` in `sphinx.directives.other` (Deprecated since Sphinx 2). Use `sphinx.domains.changeset.VersionChange` directly. Patch by Adam Turner. ## Deprecated - [#​12643](https://redirect.github.com/sphinx-doc/sphinx/issues/12643): Renamed `sphinx.ext.intersphinx.normalize_intersphinx_mapping` to `sphinx.ext.intersphinx.validate_intersphinx_mapping`. The old name will be removed in Sphinx 10. Patch by Adam Turner. - [#​12650](https://redirect.github.com/sphinx-doc/sphinx/issues/12650), [#​12686](https://redirect.github.com/sphinx-doc/sphinx/issues/12686), [#​12690](https://redirect.github.com/sphinx-doc/sphinx/issues/12690): Extend the deprecation for string methods on `pathlib.Path` objects to Sphinx 9. Use `os.fspath` to convert :py:class:`~pathlib.Path` objects to strings, or `pathlib.Path`'s methods to work with path objects. Patch by Adam Turner. ### [`v7.4.7`](https://redirect.github.com/sphinx-doc/sphinx/blob/HEAD/CHANGES.rst#Release-747-released-Jul-20-2024) [Compare Source](https://redirect.github.com/sphinx-doc/sphinx/compare/v7.4.6...v7.4.7) \===================================== ## Bugs fixed - [#​12096](https://redirect.github.com/sphinx-doc/sphinx/issues/12096): Warn when files are overwritten in the build directory. Patch by Adam Turner and Bénédikt Tran. - [#​12620](https://redirect.github.com/sphinx-doc/sphinx/issues/12620): Ensure that old-style object description options are respected. Patch by Adam Turner. - [#​12601](https://redirect.github.com/sphinx-doc/sphinx/issues/12601), [#​12625](https://redirect.github.com/sphinx-doc/sphinx/issues/12625): Support callable objects in :py:class:`~typing.Annotated` type metadata in the Python domain. Patch by Adam Turner. - [#​12601](https://redirect.github.com/sphinx-doc/sphinx/issues/12601), [#​12622](https://redirect.github.com/sphinx-doc/sphinx/issues/12622): Resolve :py:class:`~typing.Annotated` warnings with `sphinx.ext.autodoc`, especially when using :mod:`dataclasses` as type metadata. Patch by Adam Turner. - [#​12589](https://redirect.github.com/sphinx-doc/sphinx/issues/12589), [#​12626](https://redirect.github.com/sphinx-doc/sphinx/issues/12626): autosummary: Fix warnings with :rst:role:`!autolink`. Patch by Adam Turner. ### [`v7.4.6`](https://redirect.github.com/sphinx-doc/sphinx/blob/HEAD/CHANGES.rst#Release-746-released-Jul-18-2024) [Compare Source](https://redirect.github.com/sphinx-doc/sphinx/compare/v7.4.5...v7.4.6) \===================================== ## Bugs fixed - [#​12589](https://redirect.github.com/sphinx-doc/sphinx/issues/12589), [#​9743](https://redirect.github.com/sphinx-doc/sphinx/issues/9743), [#​12609](https://redirect.github.com/sphinx-doc/sphinx/issues/12609): autosummary: Do not add the package prefix when generating autosummary directives for modules within a package. Patch by Adam Turner. - [#​12613](https://redirect.github.com/sphinx-doc/sphinx/issues/12613): Reduce log severity for ambiguity detection during inventory loading. Patch by James Addison. ### [`v7.4.5`](https://redirect.github.com/sphinx-doc/sphinx/blob/HEAD/CHANGES.rst#Release-745-released-Jul-16-2024) [Compare Source](https://redirect.github.com/sphinx-doc/sphinx/compare/v7.4.4...v7.4.5) \===================================== ## Bugs fixed - [#​12593](https://redirect.github.com/sphinx-doc/sphinx/issues/12593), [#​12600](https://redirect.github.com/sphinx-doc/sphinx/issues/12600): Revert coercing the type of selected :confval:`html_sidebars` values to a list. Log an error message when string values are detected. Patch by Adam Turner. - [#​12594](https://redirect.github.com/sphinx-doc/sphinx/issues/12594): LaTeX: since 7.4.0, :rst:dir:`seealso` and other "light" admonitions now break PDF builds if they contain a :dudir:`figure` directive; and also if they are contained in a table cell (rendered by `tabulary`). Patch by Jean-François B. ### [`v7.4.4`](https://redirect.github.com/sphinx-doc/sphinx/blob/HEAD/CHANGES.rst#Release-744-released-Jul-15-2024) [Compare Source](https://redirect.github.com/sphinx-doc/sphinx/compare/v7.4.3...v7.4.4) \===================================== ## Bugs fixed - [#​12585](https://redirect.github.com/sphinx-doc/sphinx/issues/12585), [#​12586](https://redirect.github.com/sphinx-doc/sphinx/issues/12586): Do not warn when an intersphinx inventory contains case-insensitively ambiguous duplicate items. Patch by James Addison. ### [`v7.4.3`](https://redirect.github.com/sphinx-doc/sphinx/blob/HEAD/CHANGES.rst#Release-743-released-Jul-15-2024) [Compare Source](https://redirect.github.com/sphinx-doc/sphinx/compare/v7.4.2...v7.4.3) \===================================== ## Bugs fixed - [#​12582](https://redirect.github.com/sphinx-doc/sphinx/issues/12582): Restore support for list-styled :confval:`source_suffix` values with extensions that register parsers. Patch by Adam Turner. ### [`v7.4.2`](https://redirect.github.com/sphinx-doc/sphinx/blob/HEAD/CHANGES.rst#Release-742-released-Jul-15-2024) [Compare Source](https://redirect.github.com/sphinx-doc/sphinx/compare/v7.4.1...v7.4.2) \===================================== ## Bugs fixed - [#​12580](https://redirect.github.com/sphinx-doc/sphinx/issues/12580), [#​12583](https://redirect.github.com/sphinx-doc/sphinx/issues/12583): Resolve failures with the C domain on incremental builds with Sphinx 7.3.7 and earlier. Patch by Adam Turner. ### [`v7.4.1`](https://redirect.github.com/sphinx-doc/sphinx/blob/HEAD/CHANGES.rst#Release-741-released-Jul-15-2024) [Compare Source](https://redirect.github.com/sphinx-doc/sphinx/compare/v7.4.0...v7.4.1) \===================================== ## Bugs fixed - Fix invalid HTML when a rubric node with invalid `heading-level` is used. Patch by Adam Turner. - [#​12579](https://redirect.github.com/sphinx-doc/sphinx/issues/12579), [#​12581](https://redirect.github.com/sphinx-doc/sphinx/issues/12581): Restore support for `typing.ParamSpec` in autodoc. Patch by Adam Turner. ### [`v7.4.0`](https://redirect.github.com/sphinx-doc/sphinx/blob/HEAD/CHANGES.rst#Release-740-released-Jul-15-2024) [Compare Source](https://redirect.github.com/sphinx-doc/sphinx/compare/v7.3.7...v7.4.0) \===================================== ## Dependencies - [#​12555](https://redirect.github.com/sphinx-doc/sphinx/issues/12555): Drop Docutils 0.18.1 and Docutils 0.19 support. Patch by Adam Turner. - LaTeX: the `xcolor` package is now required (but is for example part of Ubuntu `texlive-latex-recommended` which has always been required). - LaTeX: the `fontawesome5` LaTeX package is needed for the default choices of icons now used in admonition titles in PDF output; but if unavailable the PDF build will simply silently omit rendering such icons. Check the documentation of the `iconpackage` key of :ref:`'sphinxsetup' ` for more. ## Deprecated - LaTeX: the `sphinxlightbox` environment is not used anymore, all types of admonitions use (by default) only `sphinxheavybox`. ## Features added .. rst-class:: compact - [#​11165](https://redirect.github.com/sphinx-doc/sphinx/issues/11165): Support the `officially recommended`\_ `.jinja` suffix for template files. Patch by James Addison and Adam Turner .. \_officially recommended: https://jinja.palletsprojects.com/en/latest/templates/#template-file-extension - [#​12325](https://redirect.github.com/sphinx-doc/sphinx/issues/12325): Flatten `Union[Literal[T], Literal[U], ...]` to `Literal[T, U, ...]` when turning annotations into strings. Patch by Adam Turner. - [#​12319](https://redirect.github.com/sphinx-doc/sphinx/issues/12319): `sphinx.ext.extlinks`: Add `extlink-{name}` CSS class to links. Patch by Hugo van Kemenade. - [#​12387](https://redirect.github.com/sphinx-doc/sphinx/issues/12387): Improve CLI progress message, when copying assets. Patch by INADA Nakoi and Bénédikt Tran. - [#​12361](https://redirect.github.com/sphinx-doc/sphinx/issues/12361): Add :attr:`.BuildEnvironment.parser`. Patch by Chris Sewell. - [#​12358](https://redirect.github.com/sphinx-doc/sphinx/issues/12358): Add :attr:`.Sphinx.fresh_env_used`. Patch by Chris Sewell. - [#​12329](https://redirect.github.com/sphinx-doc/sphinx/issues/12329): Add detection of ambiguous `std:label` and `std:term` references during loading and resolution of Intersphinx targets. Patch by James Addison. - [#​12422](https://redirect.github.com/sphinx-doc/sphinx/issues/12422): Do not duplicate "navigation" in aria-label of built-in themes. Patch by Thomas Weißschuh - [#​12421](https://redirect.github.com/sphinx-doc/sphinx/issues/12421): Include project name in `logo_alt` of built-in themes. Patch by Thomas Weißschuh - [#​12448](https://redirect.github.com/sphinx-doc/sphinx/issues/12448): Add :option:`sphinx-apidoc --remove-old` option. Patch by Chris Sewell. - [#​12456](https://redirect.github.com/sphinx-doc/sphinx/issues/12456): Add :option:`sphinx-autogen --remove-old` option. Patch by Chris Sewell. - [#​12479](https://redirect.github.com/sphinx-doc/sphinx/issues/12479): Add warning subtype `toc.no_title`. Patch by Ondřej Navrátil. - [#​12492](https://redirect.github.com/sphinx-doc/sphinx/issues/12492): Add helper methods for parsing reStructuredText content into nodes from within a directive. - :py:meth:`~sphinx.util.docutils.SphinxDirective.parse_content_to_nodes()` parses the directive's content and returns a list of Docutils nodes. - :py:meth:`~sphinx.util.docutils.SphinxDirective.parse_text_to_nodes()` parses the provided text and returns a list of Docutils nodes. - :py:meth:`~sphinx.util.docutils.SphinxDirective.parse_inline()` parses the provided text into inline elements and text nodes. Patch by Adam Turner. - [#​12258](https://redirect.github.com/sphinx-doc/sphinx/issues/12258): Support `typing_extensions.Unpack` Patch by Bénédikt Tran and Adam Turner. - [#​12524](https://redirect.github.com/sphinx-doc/sphinx/issues/12524): Add a `class` option to the :rst:dir:`toctree` directive. Patch by Tim Hoffmann. - [#​12536](https://redirect.github.com/sphinx-doc/sphinx/issues/12536): Add the :rst:dir:`confval` directive. Patch by Adam Turner. - [#​12537](https://redirect.github.com/sphinx-doc/sphinx/issues/12537): :confval:`c_id_attributes`, :confval:`c_paren_attributes`, :confval:`cpp_id_attributes`, and :confval:`cpp_paren_attributes` can now be a tuple of strings. :confval:`c_extra_keywords`, :confval:`gettext_additional_targets`, :confval:`html_domain_indices`, :confval:`latex_domain_indices`, and :confval:`texinfo_domain_indices`, can now be a set of strings. Patch by Adam Turner. - [#​12523](https://redirect.github.com/sphinx-doc/sphinx/issues/12523): Added configuration option, :confval:`math_numsep`, to define the separator for math numbering. Patch by Thomas Fanning - [#​11592](https://redirect.github.com/sphinx-doc/sphinx/issues/11592): Add :confval:`coverage_modules` to the coverage builder to allow explicitly specifying which modules should be documented. Patch by Stephen Finucane. - [#​7896](https://redirect.github.com/sphinx-doc/sphinx/issues/7896), [#​11989](https://redirect.github.com/sphinx-doc/sphinx/issues/11989): Add a :rst:dir:`py:type` directive for documenting type aliases, and a :rst:role:`py:type` role for linking to them. Patch by Ashley Whetter. - [#​12549](https://redirect.github.com/sphinx-doc/sphinx/issues/12549): Add optional `description` argument to :meth:`.Sphinx.add_config_value`. Patch by Chris Sewell. - [#​6792](https://redirect.github.com/sphinx-doc/sphinx/issues/6792): Prohibit module import cycles in :mod:`sphinx.ext.autosummary`. Patch by Trevor Bekolay. - [#​12508](https://redirect.github.com/sphinx-doc/sphinx/issues/12508): LaTeX: Revamped styling of all admonitions, with addition of a title row with icon. Patch by Jean-François B. - [#​11773](https://redirect.github.com/sphinx-doc/sphinx/issues/11773): Display :py:class:`~typing.Annotated` annotations with their metadata in the Python domain. Patch by Adam Turner and David Stansby. - [#​12506](https://redirect.github.com/sphinx-doc/sphinx/issues/12506): Add `heading-level` option to :rst:dir:`rubric` directive. Patch by Chris Sewell. - [#​12567](https://redirect.github.com/sphinx-doc/sphinx/issues/12567): Add the :event:`write-started` event. Patch by Chris Sewell. ## Bugs fixed - [#​12314](https://redirect.github.com/sphinx-doc/sphinx/issues/12314): Properly format `collections.abc.Callable` in annotations. Patch by Adam Turner. - [#​12162](https://redirect.github.com/sphinx-doc/sphinx/issues/12162): Fix a performance regression in the C domain that has been present since version 3.0.0. Patch by Donald Hunter. - [#​12320](https://redirect.github.com/sphinx-doc/sphinx/issues/12320): Fix removal of anchors from search summaries (regression in 7.3.0). Patch by Will Lachance. - [#​12251](https://redirect.github.com/sphinx-doc/sphinx/issues/12251): Fix `merge_domaindata()` in `sphinx.ext.duration`. Patch by Matthias Geier. - [#​12224](https://redirect.github.com/sphinx-doc/sphinx/issues/12224): Properly detect WebP files. Patch by Benjamin Cabé. - [#​12380](https://redirect.github.com/sphinx-doc/sphinx/issues/12380): LaTeX: Avoid footnote markers `Page N` when `N` is already the current page number. Patch by Jean-François B. - [#​12410](https://redirect.github.com/sphinx-doc/sphinx/issues/12410): LaTeX: for French and `'lualatex'` as :confval:`latex_engine` use `babel` as with `'xelatex'` (and not `polyglossia`). Patch by Jean-François B. - [#​12520](https://redirect.github.com/sphinx-doc/sphinx/issues/12520): LaTeX: let :rst:dir:`todolist` produce correct hyperlinks in PDF. Patch by Jean-François B. - [#​12416](https://redirect.github.com/sphinx-doc/sphinx/issues/12416): Ensure that configuration setting aliases are always synchronised when one value or the other is modified. Patch by Bénédikt Tran. - [#​12220](https://redirect.github.com/sphinx-doc/sphinx/issues/12220): Fix loading custom template translations for `en` locale. Patch by Nicolas Peugnet. - [#​12459](https://redirect.github.com/sphinx-doc/sphinx/issues/12459): Add valid-type arguments to the `linkcheck_rate_limit_timeout` configuration setting. Patch by James Addison. - [#​12331](https://redirect.github.com/sphinx-doc/sphinx/issues/12331): Resolve data-URI-image-extraction regression from v7.3.0 affecting builders without native support for data-URIs in their output format. Patch by James Addison. - [#​12494](https://redirect.github.com/sphinx-doc/sphinx/issues/12494): Fix invalid genindex.html file produced with translated docs (regression in 7.1.0). Patch by Nicolas Peugnet. - [#​11961](https://redirect.github.com/sphinx-doc/sphinx/issues/11961): Omit anchor references from document title entries in the search index, removing duplication of search results. Patch by James Addison. - [#​12425](https://redirect.github.com/sphinx-doc/sphinx/issues/12425): Use Docutils' SVG processing in the HTML builder and remove Sphinx's custom logic. Patch by Tunç Başar Köse. - [#​12391](https://redirect.github.com/sphinx-doc/sphinx/issues/12391): Adjust scoring of matches during HTML search so that document main titles tend to rank higher than subsection titles. In addition, boost matches on the name of programming domain objects relative to title/subtitle matches. Patch by James Addison and Will Lachance. - [#​9634](https://redirect.github.com/sphinx-doc/sphinx/issues/9634): Do not add a fallback language by stripping the country code. Patch by Alvin Wong. - [#​12352](https://redirect.github.com/sphinx-doc/sphinx/issues/12352): Add domain objects to the table of contents in the same order as defined in the document. Previously, each domain used language-specific nesting rules, which removed control from document authors. Patch by Jakob Lykke Andersen and Adam Turner. - [#​11041](https://redirect.github.com/sphinx-doc/sphinx/issues/11041): linkcheck: Ignore URLs that respond with non-Unicode content. Patch by James Addison. - [#​12543](https://redirect.github.com/sphinx-doc/sphinx/issues/12543): Fix :pep:`695` formatting for LaTeX output. Patch by Bénédikt Tran. ## Testing - karma: refactor HTML search tests to use fixtures generated by Sphinx. Patch by James Addison. ### [`v7.3.7`](https://redirect.github.com/sphinx-doc/sphinx/blob/HEAD/CHANGES.rst#Release-737-released-Apr-19-2024) [Compare Source](https://redirect.github.com/sphinx-doc/sphinx/compare/v7.3.6...v7.3.7) \===================================== ## Bugs fixed - [#​12299](https://redirect.github.com/sphinx-doc/sphinx/issues/12299): Defer loading themes defined via entry points until their explicit use by the user or a child theme. Patch by Adam Turner. - [#​12305](https://redirect.github.com/sphinx-doc/sphinx/issues/12305): Return the default value for `theme.get_config()` with an unsupported theme configuration section. Patch by Adam Turner. ### [`v7.3.6`](https://redirect.github.com/sphinx-doc/sphinx/blob/HEAD/CHANGES.rst#Release-736-released-Apr-17-2024) [Compare Source](https://redirect.github.com/sphinx-doc/sphinx/compare/v7.3.5...v7.3.6) \===================================== ## Bugs fixed - [#​12295](https://redirect.github.com/sphinx-doc/sphinx/issues/12295): Re-export all AST types in the C and C++ domains. Patch by Adam Turner. - [#​12295](https://redirect.github.com/sphinx-doc/sphinx/issues/12295): Re-export various objects from `sphinx.domains.python._annotations` in `sphinx.domains.python`. Patch by Jacob Chesslo and Adam Turner. ### [`v7.3.5`](https://redirect.github.com/sphinx-doc/sphinx/blob/HEAD/CHANGES.rst#Release-735-released-Apr-17-2024) [Compare Source](https://redirect.github.com/sphinx-doc/sphinx/compare/v7.3.4...v7.3.5) \===================================== ## Bugs fixed - [#​12295](https://redirect.github.com/sphinx-doc/sphinx/issues/12295): Re-export various objects from `sphinx.domains.python._object` in `sphinx.domains.python`. Patch by Jacob Chesslo and Adam Turner. ### [`v7.3.4`](https://redirect.github.com/sphinx-doc/sphinx/blob/HEAD/CHANGES.rst#Release-734-released-Apr-17-2024) [Compare Source](https://redirect.github.com/sphinx-doc/sphinx/compare/v7.3.3...v7.3.4) \===================================== ## Bugs fixed - Handle cases when `Any` is not an instance of `type`. Patch by Adam Turner. ### [`v7.3.3`](https://redirect.github.com/sphinx-doc/sphinx/blob/HEAD/CHANGES.rst#Release-733-released-Apr-17-2024) [Compare Source](https://redirect.github.com/sphinx-doc/sphinx/compare/v7.3.2...v7.3.3) \===================================== ## Bugs fixed - [#​12290](https://redirect.github.com/sphinx-doc/sphinx/issues/12290): Fix a false-positive warning when setting a configuration value with `Any` as the valid type to a type other than the value's default. Patch by Adam Turner. ### [`v7.3.2`](https://redirect.github.com/sphinx-doc/sphinx/blob/HEAD/CHANGES.rst#Release-732-released-Apr-17-2024) [Compare Source](https://redirect.github.com/sphinx-doc/sphinx/compare/v7.3.1...v7.3.2) \===================================== ## Bugs fixed - Preload all themes defined via entry points. Patch by Adam Turner. - Fix a bad interaction between the `'Furo'` theme and the new-style for configuration values. Patch by Adam Turner. ### [`v7.3.1`](https://redirect.github.com/sphinx-doc/sphinx/blob/HEAD/CHANGES.rst#Release-731-released-Apr-17-2024) [Compare Source](https://redirect.github.com/sphinx-doc/sphinx/compare/v7.3.0...v7.3.1) \===================================== ## Dependencies - Require `tomli` on Python 3.10 and earlier. Patch by Adam Turner. ### [`v7.3.0`](https://redirect.github.com/sphinx-doc/sphinx/blob/HEAD/CHANGES.rst#Release-730-released-Apr-16-2024) [Compare Source](https://redirect.github.com/sphinx-doc/sphinx/compare/v7.2.6...v7.3.0) \===================================== ## Dependencies - [#​11858](https://redirect.github.com/sphinx-doc/sphinx/issues/11858): Increase the minimum supported version of Alabaster to 0.7.14. Patch by Adam Turner. - [#​11411](https://redirect.github.com/sphinx-doc/sphinx/issues/11411): Support `Docutils 0.21`\_. Patch by Adam Turner. .. \_Docutils 0.21: https://docutils.sourceforge.io/RELEASE-NOTES.html#release-0-21-2024-04-09 - [#​12012](https://redirect.github.com/sphinx-doc/sphinx/issues/12012): Use `types-docutils` instead of `docutils-stubs`. ## Deprecated - [#​11693](https://redirect.github.com/sphinx-doc/sphinx/issues/11693): Support for old-style :file:`Makefile` and :file:`make.bat` output in :program:`sphinx-quickstart`, and the associated options :option:`!-M`, :option:`!-m`, :option:`!--no-use-make-mode`, and :option:`!--use-make-mode`. - [#​11285](https://redirect.github.com/sphinx-doc/sphinx/issues/11285): Direct access to :attr:`!sphinx.testing.util.SphinxTestApp._status` or :attr:`!sphinx.testing.util.SphinxTestApp._warning` is deprecated. Use the public properties :attr:`!sphinx.testing.util.SphinxTestApp.status` and :attr:`!sphinx.testing.util.SphinxTestApp.warning` instead. Patch by Bénédikt Tran. - tests: :func:`!sphinx.testing.util.strip_escseq` is deprecated in favour of :func:`!sphinx.util.console.strip_colors`. Patch by Bénédikt Tran. ## Features added - [#​12265](https://redirect.github.com/sphinx-doc/sphinx/issues/12265): Support theme configuration via `theme.toml`. - [#​11701](https://redirect.github.com/sphinx-doc/sphinx/issues/11701): HTML Search: Adopt the new `\`\_ element. Patch by Bénédikt Tran. .. \_`\`: https://developer.mozilla.org/en-US/docs/Web/HTML/Element/search - [#​11776](https://redirect.github.com/sphinx-doc/sphinx/issues/11776): Add long option names to `sphinx-build`. Patch by Hugo van Kemenade, Adam Turner, Bénédikt Tran, and Ezio Melotti. - Organise the `sphinx-build` options into groups. Patch by Adam Turner. - [#​11855](https://redirect.github.com/sphinx-doc/sphinx/issues/11855): Defer computation of configuration values. Patch by Adam Turner. - Add `:no-search:` as an alias of the `:nosearch:` metadata field. Patch by Adam Turner. - [#​11803](https://redirect.github.com/sphinx-doc/sphinx/issues/11803): autodoc: Use an overriden `__repr__()` function in an enum, if defined. Patch by Shengyu Zhang. - [#​11825](https://redirect.github.com/sphinx-doc/sphinx/issues/11825): Allow custom targets in the manpage role. Patch by Nicolas Peugnet. - [#​11892](https://redirect.github.com/sphinx-doc/sphinx/issues/11892): Improved performance when resolving cross references in the C++ domain. Patch by Rouslan Korneychuk. - [#​11905](https://redirect.github.com/sphinx-doc/sphinx/issues/11905): Add a :rst:dir:`versionremoved` directive. Patch by Hugo van Kemenade, Adam Turner, and C.A.M. Gerlach. - [#​11981](https://redirect.github.com/sphinx-doc/sphinx/issues/11981): Improve rendering of signatures using `slice` syntax, e.g., `def foo(arg: np.float64[:,:]) -> None: ...`. - The manpage builder now adds `OSC 8`\_ anchors to hyperlinks, using the `groff`\_ device control command. .. \_OSC 8: https://gist.github.com/egmontkob/eb114294efbcd5adb1944c9f3cb5feda .. \_groff: https://lists.gnu.org/archive/html/groff/2021-10/msg00000.html - [#​11015](https://redirect.github.com/sphinx-doc/sphinx/issues/11015): Change the text of the :rst:dir:`versionadded` directive from `New in [...]` to `Added in [...]`. Patch by Bénédikt Tran. - [#​12131](https://redirect.github.com/sphinx-doc/sphinx/issues/12131): Added :confval:`show_warning_types` configuration option. Patch by Chris Sewell. - [#​12193](https://redirect.github.com/sphinx-doc/sphinx/issues/12193): Improve `external` warnings for unknown roles. In particular, suggest related role names if an object type is mistakenly used. Patch by Chris Sewell. - Add public type alias :class:`sphinx.util.typing.ExtensionMetadata`. This can be used by extension developers to annotate the return type of their `setup` function. Patch by Chris Sewell. ## Bugs fixed - [#​11668](https://redirect.github.com/sphinx-doc/sphinx/issues/11668): Raise a useful error when `theme.conf` is missing. Patch by Vinay Sajip. - [#​11622](https://redirect.github.com/sphinx-doc/sphinx/issues/11622): Ensure that the order of keys in `searchindex.js` is deterministic. Patch by Pietro Albini. - [#​11617](https://redirect.github.com/sphinx-doc/sphinx/issues/11617): ANSI control sequences are stripped from the output when writing to a warnings file with :option:`-w `. Patch by Bénédikt Tran. - [#​11666](https://redirect.github.com/sphinx-doc/sphinx/issues/11666): Skip all hidden directories in `CatalogRepository.pofiles`. Patch by Aryaz Eghbali. - [#​9686](https://redirect.github.com/sphinx-doc/sphinx/issues/9686): html builder: Fix MathJax lazy loading when equations appear in titles. Patch by Bénédikt Tran. - [#​11483](https://redirect.github.com/sphinx-doc/sphinx/issues/11483): singlehtml builder: Fix MathJax lazy loading when the index does not contain any math equations. Patch by Bénédikt Tran. - [#​11697](https://redirect.github.com/sphinx-doc/sphinx/issues/11697): HTML Search: add 'noindex' meta robots tag. Patch by James Addison. - [#​11678](https://redirect.github.com/sphinx-doc/sphinx/issues/11678): Fix a possible `ZeroDivisionError` in `sphinx.ext.coverage`. Patch by Stephen Finucane. - [#​11756](https://redirect.github.com/sphinx-doc/sphinx/issues/11756): LaTeX: build error with recent TeXLive due to missing `substitutefont` package (triggered if using `fontenc` with `T2A` option and document language is not a Cyrillic one). Patch by Jean-François B. - [#​11675](https://redirect.github.com/sphinx-doc/sphinx/issues/11675): Fix rendering of progression bars in environments that do not support ANSI control sequences. Patch by Bénédikt Tran. - [#​11861](https://redirect.github.com/sphinx-doc/sphinx/issues/11861): Whitelist more types with an incorrect `__module__` attribute. Patch by Adam Turner. - [#​11715](https://redirect.github.com/sphinx-doc/sphinx/issues/11715): Apply `tls_verify` and `tls_cacerts` config to `ImageDownloader`. Patch by Nick Touran. - Allow hyphens in group names for :rst:dir:`productionlist` cross-references. Patch by Adam Turner. - [#​11433](https://redirect.github.com/sphinx-doc/sphinx/issues/11433): Added the :confval:`linkcheck_allow_unauthorized` configuration option. Set this option to `False` to report HTTP 401 (unauthorized) server responses as broken. Patch by James Addison. - [#​11868](https://redirect.github.com/sphinx-doc/sphinx/issues/11868): linkcheck: added a distinct `timeout` reporting status code. This can be enabled by setting :confval:`linkcheck_report_timeouts_as_broken` to `False`. Patch by James Addison. - [#​11869](https://redirect.github.com/sphinx-doc/sphinx/issues/11869): Refresh the documentation for the `linkcheck_timeout` setting. Patch by James Addison. - [#​11874](https://redirect.github.com/sphinx-doc/sphinx/issues/11874): Configure a default 30-second value for `linkcheck_timeout`. Patch by James Addison. - [#​11886](https://redirect.github.com/sphinx-doc/sphinx/issues/11886): Print the Jinja2 template path chain in `TemplateNotFound` exceptions. Patch by Colin Marquardt. - [#​11598](https://redirect.github.com/sphinx-doc/sphinx/issues/11598): Do not use query components in URLs for assets in EPUB rendering. Patch by David Runge. - [#​11904](https://redirect.github.com/sphinx-doc/sphinx/issues/11904): Support unary subtraction when parsing annotations. Patch by James Addison. - [#​11925](https://redirect.github.com/sphinx-doc/sphinx/issues/11925): Blacklist the `sphinxprettysearchresults` extension; the functionality it provides was merged into Sphinx v2.0.0. Patch by James Addison. - [#​11917](https://redirect.github.com/sphinx-doc/sphinx/issues/11917): Fix rendering of annotated inherited members for Python 3.9. Patch by Janet Carson. - [#​11935](https://redirect.github.com/sphinx-doc/sphinx/issues/11935): C Domain: Fix namespace-pop context. Patch by Frank Dana. - [#​11923](https://redirect.github.com/sphinx-doc/sphinx/issues/11923): Avoid zombie processes when parallel builds fail. Patch by Felix von Drigalski. - [#​11353](https://redirect.github.com/sphinx-doc/sphinx/issues/11353): Support enumeration classes inheriting from mixin or data types. Patch by Bénédikt Tran. - [#​11962](https://redirect.github.com/sphinx-doc/sphinx/issues/11962): Fix target resolution when using `:paramtype:` fields. Patch by Bénédikt Tran. - [#​11944](https://redirect.github.com/sphinx-doc/sphinx/issues/11944): Use anchor in search preview. Patch by Will Lachance. - [#​12008](https://redirect.github.com/sphinx-doc/sphinx/issues/12008): Fix case-sensitive lookup of `std:label` names in intersphinx inventory. Patch by Michael Goerz. - [#​11958](https://redirect.github.com/sphinx-doc/sphinx/issues/11958): HTML Search: Fix partial matches overwriting full matches. Patch by William Lachance. - [#​11959](https://redirect.github.com/sphinx-doc/sphinx/issues/11959): Fix multiple term matching when word appears in both title and document. Patch by Will Lachance. - [#​11474](https://redirect.github.com/sphinx-doc/sphinx/issues/11474): Fix doctrees caching causing files not be rebuilt in some cases, e.g., when :confval:`numfig` is `True`. Patch by Bénédikt Tran. - [#​11278](https://redirect.github.com/sphinx-doc/sphinx/issues/11278): autodoc: Fix rendering of :class:`functools.singledispatchmethod` combined with :func:`@classmethod `. Patch by Bénédikt Tran. - [#​11894](https://redirect.github.com/sphinx-doc/sphinx/issues/11894): Do not add checksums to css files if building using the htmlhelp builder. Patch by reduerK akiM. - [#​12052](https://redirect.github.com/sphinx-doc/sphinx/issues/12052): Remove ` Githubissues.

Githubissues is a development platform for aggregating issues.