Update dependency Sphinx to v8

[renovate]

This PR contains the following updates:

Package	Change	Age	Adoption	Passing	Confidence
Sphinx (changelog)	~=7.2.6 -> ~=8.2.0

---

Release Notes

sphinx-doc/sphinx (Sphinx)

v8.2.0

Compare Source

==============================

Dependencies

• #​13000: Drop Python 3.10 support.

Incompatible changes

• #​13044: Remove the internal and undocumented has_equations data
  from the :py:class:!MathDomain domain.
  The undocumented :py:meth:!MathDomain.has_equations method
  now unconditionally returns True.
  These are replaced by the has_maths_elements key of the page context dict.
  Patch by Adam Turner.
• #​13227: HTML output for sequences of keys in the :rst:role:kbd role
  no longer uses a <kbd class="kbd compound"> element to wrap
  the keys and separators, but places them directly in the relevant parent node.
  This means that CSS rulesets targeting kbd.compound or .kbd.compound
  will no longer have any effect.
  Patch by Adam Turner.

Deprecated

• #​13037: Deprecate the SingleHTMLBuilder.fix_refuris method.
  Patch by James Addison.
• #​13083, #​13330: Un-deprecate sphinx.util.import_object.
  Patch by Matthias Geier.

Features added

• #​13173: Add a new duplicate_declaration warning type,
  with duplicate_declaration.c and duplicate_declaration.cpp subtypes.
  Patch by Julien Lecomte and Adam Turner.
• #​11824: linkcode: Allow extensions to add support for a domain by defining
  the keys that should be present.
  Patch by Nicolas Peugnet.
• #​13144: Add a class option to the :rst:dir:autosummary directive.
  Patch by Tim Hoffmann.
• #​13146: Napoleon: Unify the type preprocessing logic to allow
  Google-style docstrings to use the optional and default keywords.
  Patch by Chris Barrick.
• #​13227: Implement the :rst:role:kbd role as a SphinxRole.
  Patch by Adam Turner.
• #​13065: Enable colour by default in when running on CI.
  Patch by Adam Turner.
• #​13230: Allow supressing warnings from the :rst:dir:toctree directive
  when a glob pattern doesn't match any documents,
  via the new toc.empty_glob warning sub-type.
  Patch by Slawek Figiel.
• #​9732: Add the new autodoc.mocked_object warnings sub-type.
  Patch by Cyril Roelandt.
• #​7630, #​4824: autodoc: Use :file:.pyi type stub files
  to auto-document native modules.
  Patch by Adam Turner, partially based on work by Allie Fitter.
• #​12975: Enable configuration of trailing commas in multi-line signatures
  in the Python and Javascript domains, via the new
  :confval:python_trailing_comma_in_multi_line_signatures and
  :confval:javascript_trailing_comma_in_multi_line_signatures
  configuration options.
• #​13264: Rename the :rst:dir:math directive's nowrap option
  to :rst:dir:math:no-wrap.
  Patch by Adam Turner.
• #​13269: Added the option to disable the use of type comments in
  via the new :confval:autodoc_use_type_comments option,
  which defaults to True for backwards compatibility.
  The default will change to False in Sphinx 10.
  Patch by Adam Turner.
• #​9732: Add the new ref.any warnings sub-type
  to allow suppressing the ambiguous 'any' cross-reference warning.
  Patch by Simão Afonso and Adam Turner.
• #​13272: The Python and JavaScript module directives now support
  the :no-index-entry: option.
  Patch by Adam Turner.
• #​12233: autodoc: Allow directives to use :no-index-entry:
  and include the :no-index: and :no-index-entry: options within
  :confval:autodoc_default_options.
  Patch by Jonny Saunders and Adam Turner.
• #​13172: Add support for short signatures in autosummary.
  Patch by Tim Hoffmann.
• #​13271: Change the signature prefix for abstract methods
  in the Python domain to abstractmethod from abstract.
  Patch by Adam Turner.
• #​13271: Support the :abstract: option for
  classes, methods, and properties in the Python domain.
  Patch by Adam Turner.
• #​12507: Add the :ref:collapsible <collapsible-admonitions> option
  to admonition directives.
  Patch by Chris Sewell.
• #​8191, #​8159: Add :rst:dir:inheritance-diagram:include-subclasses option to
  the :rst:dir:inheritance-diagram directive.
  Patch by Walter Dörwald.
• #​11995: autodoc: Add support for :confval:python_display_short_literal_types.
  Patch by Bénédikt Tran and Adam Turner.
• #​13163: Always print the full context when Sphinx encounters an internal error.
  Patch by Kevin Deldycke and Adam Turner.
• #​13105: Introduce the :rst:role:py:deco role to cross-reference decorator
  functions and methods in the Python domain.
  Patch by Adam Turner.
• #​9169: Add the :confval:intersphinx_resolve_self option
  to resolve an intersphinx reference to the current project.
  Patch by Jakob Lykke Andersen and Adam Turner.
• #​11280: Add ability to skip a particular section using the no-search class.
  Patch by Will Lachance.
• #​13326: Remove hardcoding from handling :class:~sphinx.addnodes.productionlist
  nodes in all writers, to improve flexibility.
  Patch by Adam Turner.
• #​13335: Use misc.highlighting_failure subtype for Pygments unknown lexers.
  Patch by Bart Kamphorst.
• #​13354: Insert abbreviation nodes (hover text) for positional- and keyword-only
  separators in Python signatures.
  Patch by Adam Turner.
• #​13333: Add the :mod:sphinx.ext.apidoc extension,
  to automate API documentation generation from Python modules.
  Patch by Chris Sewell and Adam Turner.

Bugs fixed

• #​12463: autosummary: Respect an empty module __all__.
  Patch by Valentin Pratz
• #​13060: HTML Search: use Map to store per-file term scores.
  Patch by James Addison
• #​13130: LaTeX docs: pdflatex index creation may fail for index entries
  in French. See :confval:latex_use_xindy.
  Patch by Jean-François B.
• #​13152: LaTeX: fix a typo from v7.4.0 in a default for \sphinxboxsetup.
  Patch by Jean-François B.
• #​13096: HTML Search: check that query terms exist as properties in
  term indices before accessing them.
• #​11233: linkcheck: match redirect URIs against :confval:linkcheck_ignore by
  overriding session-level requests.get_redirect_target.
• #​13195: viewcode: Fix issue where import paths differ from the directory
  structure.
  Patch by Ben Egan and Adam Turner.
• #​13188: autodoc: fix detection of class methods implemented in C.
  Patch by Bénédikt Tran.
• #​1810: Always copy static files when building, regardless of whether
  any documents have changed since the previous build.
  Patch by Adam Turner.
• #​13201: autodoc: fix ordering of members when using groupwise
  for :confval:autodoc_member_order. Class methods are now rendered
  before static methods, which themselves are rendered before regular
  methods and attributes.
  Patch by Bénédikt Tran.
• #​12975: Avoid rendering a trailing comma in C and C++ multi-line signatures.
• #​13178: autodoc: Fix resolution for pathlib types.
  Patch by Adam Turner.
• #​13136: autodoc: Correctly handle multiple inheritance.
  Patch by Pavel Holica
• #​13273, #​13318: Properly convert command-line overrides for Boolean types.
  Patch by Adam Turner.
• #​13302, #​13319: Use the correct indentation for continuation lines
  in :rst:dir:productionlist directives.
  Patch by Adam Turner.
• #​13328: Fix parsing of PEP 695 functions with return annotations.
  Patch by Bénédikt Tran. Initial work by Arash Badie-Modiri.

Testing

• #​13224: Correctness fixup for test_html_multi_line_copyright.
  Patch by Colin Watson, applied by James Addison.

v8.1.3: Sphinx 8.1.3

Compare Source

Changelog: https://www.sphinx-doc.org/en/master/changes/8.1.html

Bugs fixed

• #​13013: Restore support for cut_lines() with no object type. Patch by Adam Turner.

v8.1.2: Sphinx 8.1.2

Compare Source

Changelog: https://www.sphinx-doc.org/en/master/changes.html

Bugs fixed

• #​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: Sphinx 8.1.1

Compare Source

Changelog: https://www.sphinx-doc.org/en/master/changes.html

Bugs fixed

• #​13006: Use the preferred https://www.cve.org/ URL for
  the :cve: role.
  Patch by Hugo van Kemenade.
• #​13007: LaTeX: Improve resiliency when the required
  fontawesome or fontawesome5 packages are not installed.
  Patch by Jean-François B.

v8.1.0

Compare Source

=====================================

Dependencies

• #​12756: Add lower-bounds to the sphinxcontrib-* dependencies.
  Patch by Adam Turner.
• #​12833: Update the LaTeX parskip package from 2001 to 2018.
  Patch by Jean-François B.

Incompatible changes

• #​12763: Remove unused internal class sphinx.util.Tee.
  Patch by Adam Turner.
• #​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: Disable smartquotes for languages: zh_CN and zh_TW by default.
  Patch by A. Rafey Khan.

Deprecated

• #​12762: Deprecate sphinx.util.import_object.
  Use :py:func:importlib.import_module instead.
  Patch by Adam Turner.
• #​12766: Deprecate sphinx.util.FilenameUniqDict
  and sphinx.util.DownloadFiles.
  Patch by Adam Turner.

Features added

• #​11328: Mention evaluation of templated content during production of static
  output files.
  Patch by James Addison.
• #​12704: LaTeX: make :dudir:contents <table-of-contents>, :dudir:topic,
  and :dudir:sidebar directives separately customizable for PDF output.
  Patch by Jean-François B. and Bénédikt Tran.
• #​12474: Support type-dependent search result highlighting via CSS.
  Patch by Tim Hoffmann.
• #​12652: LaTeX: Add :confval:math_numsep support to latex builder.
  Patch by Thomas Fanning and Jean-François B.
• #​12743: No longer exit on the first warning when
  :option:--fail-on-warning <sphinx-build --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: 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: 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: 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 <config-copyright> for further detail.
  Patch by Adam Turner.
• #​11781: Add roles for referencing CVEs (:rst:role::cve: <cve>)
  and CWEs (:rst:role::cwe: <cwe>).
  Patch by Hugo van Kemenade.
• #​11809: Improve the formatting for RFC section anchors.
  Patch by Jakub Stasiak and Adam Turner.
• #​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: 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: intersphinx: fix the meaning of a negative value for
  :confval:intersphinx_cache_limit.
  Patch by Shengyu Zhang.
• #​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: 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: LaTeX: let :ref:'sphinxsetup' <latexsphinxsetup>
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: Do not warn when potential ambiguity detected during Intersphinx
  resolution occurs due to duplicate targets that differ case-insensitively.
  Patch by James Addison.
• #​12639: Fix singular and plural search results text.
  Patch by Hugo van Kemenade.
• #​12645: Correctly support custom gettext output templates.
  Patch by Jeremy Bowman.
• #​12717: LaTeX: let :option:-q <sphinx-build -q> (quiet) option for
  :program:sphinx-build -M latexpdf or :program:make latexpdf (O=-q)
  get passed to :program:latexmk. Let :option:-Q <sphinx-build -Q>
  (silent) apply as well to the PDF build phase.
  Patch by Jean-François B.
• #​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: LaTeX: avoid large voids sometimes occurring at page bottoms.
  Patch by Jean-François B.
• #​11970, #​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: Fix :pep:695 generic classes LaTeX output formatting.
  Patch by Jean-François B. and Bénédikt Tran.
• #​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: Enable parallel reading if requested,
  even if there are fewer than 6 documents.
  Patch by Matthias Geier.
• #​12844: Restore support for :noindex: for the :rst:dir:js:module
  and :rst:dir:py:module directives.
  Patch by Stephen Finucane.
• #​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: 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: 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: 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: Significantly improve performance when building the search index
  for Chinese languages.
  Patch by Adam Turner.
• #​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: 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: Sphinx 8.0.2

Compare Source

Changelog: https://www.sphinx-doc.org/en/master/changes.html

v8.0.1: Sphinx 8.0.1

Compare Source

Changelog: https://www.sphinx-doc.org/en/master/changes.html

v8.0.0: Sphinx 8.0.0

Compare Source

Changelog: https://www.sphinx-doc.org/en/master/changes.html

Dependencies

• #​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: Raise an error for invalid html_sidebars values.
  Patch by Adam Turner.

• #​12593: Raise an error in Theme.get_config for invalid sections.
  Patch by Adam Turner.

• #​11693: Remove support for old-style Makefile and make.bat
  output in sphinx-quickstart.

• #​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: 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: Change the default of show_warning_types
  from False to True.
  Patch by Chris Sewell.

• #​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: Do not overwrite user-supplied files when copying assets
  unless forced with force=True.
  Patch by Adam Turner.

• #​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: 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, #​12686, #​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

Compare Source

=====================================

Bugs fixed

• #​12096: Warn when files are overwritten in the build directory.
  Patch by Adam Turner and Bénédikt Tran.
• #​12620: Ensure that old-style object description options are respected.
  Patch by Adam Turner.
• #​12601, #​12625: Support callable objects in :py:class:~typing.Annotated type
  metadata in the Python domain.
  Patch by Adam Turner.
• #​12601, #​12622: Resolve :py:class:~typing.Annotated warnings with
  sphinx.ext.autodoc,
  especially when using :mod:dataclasses as type metadata.
  Patch by Adam Turner.
• #​12589, #​12626: autosummary: Fix warnings with :rst:role:!autolink.
  Patch by Adam Turner.

v7.4.6

Compare Source

=====================================

Bugs fixed

• #​12589, #​9743, #​12609: autosummary: Do not add the package prefix when
  generating autosummary directives for modules within a package.
  Patch by Adam Turner.
• #​12613: Reduce log severity for ambiguity detection during inventory loading.
  Patch by James Addison.

v7.4.5

Compare Source

=====================================

Bugs fixed

• #​12593, #​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: 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

Compare Source

=====================================

Bugs fixed

• #​12585, #​12586: Do not warn when an intersphinx inventory contains
  case-insensitively ambiguous duplicate items.
  Patch by James Addison.

v7.4.3

Compare Source

=====================================

Bugs fixed

• #​12582: Restore support for list-styled :confval:source_suffix values
  with extensions that register parsers.
  Patch by Adam Turner.

v7.4.2

Compare Source

=====================================

Bugs fixed

• #​12580, #​12583: Resolve failures with the C domain on incremental builds
  with Sphinx 7.3.7 and earlier.
  Patch by Adam Turner.

v7.4.1

Compare Source

=====================================

Bugs fixed

• Fix invalid HTML when a rubric node with invalid heading-level is used.
  Patch by Adam Turner.
• #​12579, #​12581: Restore support for typing.ParamSpec in autodoc.
  Patch by Adam Turner.

v7.4.0

Compare Source

=====================================

Dependencies

• #​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' <latexsphinxsetup> 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: 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: Flatten Union[Literal[T], Literal[U], ...] to Literal[T, U, ...]
  when turning annotations into strings.
  Patch by Adam Turner.

• #​12319: sphinx.ext.extlinks: Add extlink-{name} CSS class to links.
  Patch by Hugo van Kemenade.

• #​12387: Improve CLI progress message, when copying assets.
  Patch by INADA Nakoi and Bénédikt Tran.

• #​12361: Add :attr:.BuildEnvironment.parser.
  Patch by Chris Sewell.

• #​12358: Add :attr:.Sphinx.fresh_env_used.
  Patch by Chris Sewell.

• #​12329: Add detection of ambiguous std:label and std:term references during
  loading and resolution of Intersphinx targets.
  Patch by James Addison.

• #​12422: Do not duplicate "navigation" in aria-label of built-in themes.
  Patch by Thomas Weißschuh

• #​12421: Include project name in logo_alt of built-in themes.
  Patch by Thomas Weißschuh

• #​12448: Add :option:sphinx-apidoc --remove-old option.
  Patch by Chris Sewell.

• #​12456: Add :option:sphinx-autogen --remove-old option.
  Patch by Chris Sewell.

• #​12479: Add warning subtype toc.no_title.
  Patch by Ondřej Navrátil.

• #​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: Support typing_extensions.Unpack
  Patch by Bénédikt Tran and Adam Turner.

• #​12524: Add a class option to the :rst:dir:toctree directive.
  Patch by Tim Hoffmann.

• #​12536: Add the :rst:dir:confval directive.
  Patch by Adam Turner.

• #​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: Added configuration option, :confval:math_numsep, to define the
  separator for math numbering.
  Patch by Thomas Fanning

• #​11592: Add :confval:coverage_modules to the coverage builder
  to allow explicitly specifying which modules should be documented.
  Patch by Stephen Finucane.

• #​7896, #​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: Add optional description argument to
  :meth:.Sphinx.add_config_value.
  Patch by Chris Sewell.

• #​6792: Prohibit module import cycles in :mod:sphinx.ext.autosummary.
  Patch by Trevor Bekolay.

• #​12508: LaTeX: Revamped styling of all admonitions, with addition of a
  title row with icon.
  Patch by Jean-François B.

• #​11773: Display :py:class:~typing.Annotated annotations
  with their metadata in the Python domain.
  Patch by Adam Turner and David Stansby.

• #​12506: Add heading-level option to :rst:dir:rubric directive.
  Patch by Chris Sewell.

• #​12567: Add the :event:write-started event.
  Patch by Chris Sewell.

Bugs fixed

• #​12314: Properly format collections.abc.Callable in annotations.
  Patch by Adam Turner.
• #​12162: Fix a performance regression in the C domain that has
  been present since version 3.0.0.
  Patch by Donald Hunter.
• #​12320: Fix removal of anchors from search summaries (regression in 7.3.0).
  Patch by Will Lachance.
• #​12251: Fix merge_domaindata() in sphinx.ext.duration.
  Patch by Matthias Geier.
• #​12224: Properly detect WebP files.
  Patch by Benjamin Cabé.
• #​12380: LaTeX: Avoid footnote markers Page N when N is already
  the current page number.
  Patch by Jean-François B.
• #​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: LaTeX: let :rst:dir:todolist produce correct hyperlinks in PDF.
  Patch by Jean-François B.
• #​12416: Ensure that configuration setting aliases are always synchronised
  when one value or the other is modified.
  Patch by Bénédikt Tran.
• #​12220: Fix loading custom template translations for en locale.
  Patch by Nicolas Peugnet.
• #​12459: Add valid-type arguments to the linkcheck_rate_limit_timeout
  configuration setting.
  Patch by James Addison.
• #​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: Fix invalid genindex.html file produced with translated docs
  (regression in 7.1.0).
  Patch by Nicolas Peugnet.
• #​11961: Omit anchor references from document title entries in the search index,
  removing duplication of search results.
  Patch by James Addison.
• #​12425: Use Docutils' SVG processing in the HTML builder
  and remove Sphinx's custom logic.
  Patch by Tunç Başar Köse.
• #​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: Do not add a fallback language by stripping the country code.
  Patch by Alvin Wong.
• #​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: linkcheck: Ignore URLs that respond with non-Unicode content.
  Patch by James Addison.
• #​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

Compare Source

=====================================

Bugs fixed

• #​12299: Defer loading themes defined via entry points until
  their explicit use by the user or a child theme.
  Patch by Adam Turner.
• #​12305: Return the default value for theme.get_config() with
  an unsupported theme configuration section.
  Patch by Adam Turner.

v7.3.6

Compare Source

=====================================

Bugs fixed

• #​12295: Re-export all AST types in the C and C++ domains.
  Patch by Adam Turner.
• #​12295: Re-export various objects from sphinx.domains.python._annotations
  in sphinx.domains.python.
  Patch by Jacob Chesslo and Adam Turner.

v7.3.5

Compare Source

=====================================

Bugs fixed

• #​12295: Re-export various objects from sphinx.domains.python._object
  in sphinx.domains.python.
  Patch by Jacob Chesslo and Adam Turner.

v7.3.4

Compare Source

=====================================

Bugs fixed

• Handle cases when Any is not an instance of type.
  Patch by Adam Turner.

v7.3.3

Compare Source

=====================================

Bugs fixed

• #​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

Compare Source

=====================================

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

Compare Source

=====================================

Dependencies

• Require tomli on Python 3.10 and earlier.
  Patch by Adam Turner.

v7.3.0

Compare Source

=====================================

Dependencies

• #​11858: Increase the minimum supported version of Alabaster to 0.7.14.
  Patch by Adam Turner.

• #​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: Use types-docutils instead of docutils-stubs.

Deprecated

• #​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: 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: Support theme configuration via theme.toml.

• #​11701: HTML Search: Adopt the new \<search\>_ element.
  Patch by Bénédikt Tran.

  .. _\<search\>: https://developer.mozilla.org/en-US/docs/Web/HTML/Element/search

• #​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: 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: autodoc: Use an overriden __repr__() function in an enum,
  if defined. Patch by Shengyu Zhang.

• #​11825: Allow custom targets in the manpage role.
  Patch by Nicolas Peugnet.

• #​11892: Improved performance when resolving cross references in the C++ domain.
  Patch by Rouslan Korneychuk.

• #​11905: Add a :rst:dir:versionremoved directive.
  Patch by Hugo van Kemenade, Adam Turner, and C.A.M. Gerlach.

• #​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: Change the text of the :rst:dir:versionadded directive from
  New in [...] to Added in [...].
  Patch by Bénédikt Tran.

• #​12131: Added :confval:show_warning_types configuration option.
  Patch by Chris Sewell.

• #​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: Raise a useful error when theme.conf is missing.
  Patch by Vinay Sajip.
• #​11622: Ensure that the order of keys in searchindex.js is deterministic.
  Patch by Pietro Albini.
• #​11617: ANSI control sequences are stripped from the output when writing to
  a warnings file with :option:-w <sphinx-build -w>.
  Patch by Bénédikt Tran.
• #​11666: Skip all hidden directories in CatalogRepository.pofiles.
  Patch by Aryaz Eghbali.
• #​9686: html builder: Fix MathJax lazy loading when equations appear in titles.
  Patch by Bénédikt Tran.
• #​11483: singlehtml builder: Fix MathJax lazy loading when the index does not
  contain any math equations.
  Patch by Bénédikt Tran.
• #​11697: HTML Search: add 'noindex' meta robots tag.
  Patch by James Addison.
• #​11678: Fix a possible ZeroDivisionError in sphinx.ext.coverage.
  Patch by Stephen Finucane.
• #​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: Fix rendering of progression bars in environments that do not support
  ANSI control sequences.
  Patch by Bénédikt Tran.
• #​11861: Whitelist more types with an incorrect __module__ attribute.
  Patch by Adam Turner.
• #​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: 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: 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: Refresh the documentation for the linkcheck_timeout setting.
  Patch by James Addison.
• #​11874: Configure a default 30-second value for linkcheck_timeout.
  Patch by James Addison.
• #​11886: Print the Jinja2 template path chain in TemplateNotFound exceptions.
  Patch by Colin Marquardt.
• #​11598: Do not use query components in URLs for assets in EPUB rendering.
  Patch by David Runge.
• #​11904: Support unary subtraction when parsing annotations.
  Patch by James Addison.
• #​11925: Blacklist the sphinxprettysearchresults extension; the functionality
  it provides was merged into Sphinx v2.0.0.
  Patch by James Addison.
• #​11917: Fix rendering of annotated inherited members for Python 3.9.
  Patch by Janet Carson.
• #​11935: C Domain: Fix namespace-pop context.
  Patch by Frank Dana.
• #​11923: Avoid zombie processes when parallel builds fail.
  Patch by Felix von Drigalski.
• #​11353: Support enumeration classes inheriting from mixin or dat

---

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 was generated by Mend Renovate. View the repository job log.