Update dependency Sphinx to v9 #2813
Closed
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR contains the following updates:
==8.2.3->==9.0.0Release Notes
sphinx-doc/sphinx (Sphinx)
v9.0.0=====================================
Dependencies
#13786: Support
Docutils 0.22_. Patch by Adam Turner... _Docutils 0.22: https://docutils.sourceforge.io/RELEASE-NOTES.html#release-0-22-2026-07-29
Incompatible changes
!SphinxComponentRegistry.create_source_parserno longerhas an app parameter, instead taking config and env.
Patch by Adam Turner.
Such bytes have been replaced with '?' along with logging a warning
since Sphinx 2.0.
Patch by Adam Turner.
sphinx.ext.autodochas been substantially rewritten,and there may be some incompatible changes in edge cases, especially when
extensions interact with autodoc internals.
The :confval:
autodoc_use_legacy_class_basedoption has been added touse the legacy (pre-9.0) implementation of autodoc.
Patches by Adam Turner.
Patch by Will Lachance.
Deprecated
!.appattributes,including
builder.app,env.app,events.app,and
SphinxTransform.app.Patch by Adam Turner.
!set_applicationmethodof :py:class:
~sphinx.parsers.Parserobjects.Patch by Adam Turner.
!Parser.configand :py:attr:!envattributes.Patch by Adam Turner.
scheduled for removal in Sphinx 10.
Patch by Adam Turner.
!sphinx.io.Sphinx no longer uses the :py:mod:
!sphinx.ioclasses,having replaced them with standard Python I/O.
The entire :py:mod:
!sphinx.iomodule will be removed in Sphinx 10.Patch by Adam Turner.
!sphinx.environment.adapters.toctree.global_toctree_for_docand :meth:
!sphinx.environment.BuildEnvironment.get_and_resolve_doctreewill require a tags keyword argument from Sphinx 11.
It may optionally be passed from Sphinx 9 onwards.
Patch by Adam Turner.
Features added
doctest_fail_fastoption to exit after the first failedtest.
Patch by Till Hoffmann.
linkcheck_allowed_redirects = {}.Patch by Adam Turner and James Addison.
fontawesome6package.Patch by Jean-François B.
typing_extensions.overload <typing.overload>and :py:func:
~typing.finaldecorators.Patch by Spencer Brown.
Patch by Adam Turner.
Patch by Jean-François B.
Patch by Jean-François B.
The location of the cache directory must not be relied upon externally,
as it may change without notice or warning in future releases.
Patch by Adam Turner.
fontawesome7package.Patch by Jean-François B.
695type aliases.Patch by Martin Matouš, Jeremy Maitin-Shepard, and Adam Turner.
mathjax_config_pathoptionto load MathJax configuration from a file.
Patch by Randolf Scholz and Adam Turner.
linkcheck_case_insensitive_urlsoptionto allow case-insensitive URL comparison for specific URL patterns.
This is useful for links to websites that normalise URL casing (e.g. GitHub)
or case-insensitive servers.
Patch by Fazeel Usmani and James Addison.
Patch by Philipp A.
sphinx.ext.duration.Patch by Erik Bedard and Adam Turner.
sphinx.ext.mathjaxextension,from v3 previously.
To keep using an older version, set the :confval:
mathjax_pathoption.Also add the new :confval:
mathjax4_configoption to configure MathJax v4.Note that MathJax v3 is mostly compatible with MathJax v4, so existing
:confval:
mathjax3_configsettings should not need to change.Patch by Matthias Geier.
Patch by Matthieu de Cibeins.
source_code_parsertype to :confval:suppress_warningsfor grouping issues related to the C and C++ parsers.
Patch by Valentin H.
Bugs fixed
longer result in spurious duplicate object description warnings.
Patch by Jeremy Maitin-Shepard.
:rst:dir:
tabularcolumnsspecifies automatic widths(
L,R,C, orJ).Patch by Jean-François B.
"horizontally" and overflow in right margin.
Patch by Jean-François B.
full width.
Patch by Jean-François B.
Patch by Jean-François B.
Patch by Jean-François B.
Patch by Jean-François B.
Patch by Jean-François B.
Patch by Alicia Garcia-Raboso.
~prefix support for :rst:role:py:deco.Patch by Shengyu Zhang and Adam Turner.
and PDF cannot be built.
Patch by Jean-François B.
(typically if :confval:
latex_show_urls= 'footnote').Patch by Jean-François B.
the next table cells.
Patch by Jean-François B.
Patch by Bénédikt Tran.
Patch by Szymon Karpinski.
<em class="property">with<span class="property">for attribute type annotationsto improve
semantic HTML structure <https://html.spec.whatwg.org/multipage/text-level-semantics.html>__.Patch by Mark Ostroth.
confvalvalue does not wrap atspaces in PDF.
Patch by Jean-François B.
cross-referenced when used as type annotations. This makes it possible
for objects documented as
:py:data:to be hyperlinked in function signatures.configuration variable
doctest_test_doctest_blocks.Patch by Damien Ayers.
sub-type,
ref.equation.Patch by Jared Dillard.
directly defined in certain cases, depending on autodoc processing
order.
Patch by Jeremy Maitin-Shepard.
Patch by Jean-François B.
autodoc_type_aliaseswhen they appear in PEP 604union syntax (
Alias | Type).Patch by Tamika Nomara.
(since late June 2025 upstream change to LaTeX
babel-french).Patch by Jean-François B.
Patch by Harmen Stoppels.
Patch by Florian Best.
Patch by Shengyu Zhang and Adam Turner.
Some type variables (...) are not listed in Generic[...]TypeError when inheriting from both Generic and autodoc mocked class.
Patch by Ikor Jefocur and Daniel Sperber.
the
FORWARDREF:mod:annotationlibformat.Patch by Rui Pinheiro and Adam Turner.
resolve duplicates in the manifest on Windows.
Patch by Akihiro Takizawa.
Patch by Bénédikt Tran.
js:functionarguments and errors.Patch by Shengyu Zhang.
Testing
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.
This PR was generated by Mend Renovate. View the repository job log.