chore(deps): update dependency sphinx to v9 #368
Conversation
renovate
bot
added
bot
renovate
bot
requested a review
from helmut-hoffer-von-ankershoffen
as a code owner
renovate
bot
added
renovate
|
renovate
bot
force-pushed
the
renovate/sphinx-9.x
branch
from
fa46bd5 to
2decb1e
Compare
|
![sentry[bot]](https://avatars.githubusercontent.com/u/1396951?s=60&v=4){kind=small}
| "ruff>=0.14.8,<1", | ||
| "scalene>=1.5.55,<2", | ||
| "sphinx>=8.2.3,<9", | ||
| "sphinx>=9.1,<10", |
There was a problem hiding this comment.
Bug: The update to sphinx>=9.1 is incompatible with the project's declared Python support for version 3.11 in pyproject.toml, which will cause installation failures.
Severity: CRITICAL | Confidence: High
🔍 Detailed Analysis
The project's pyproject.toml is being updated to require sphinx>=9.1,<10. However, the official Sphinx 9.1.0 release dropped support for Python 3.11 and requires Python 3.12 or newer. The project's configuration still declares support for Python 3.11 via requires-python = ">=3.11, <3.15". This incompatibility will cause a hard dependency resolution failure for any user attempting to install this package on a Python 3.11 environment, preventing installation entirely.
💡 Suggested Fix
To resolve the incompatibility, either update the requires-python declaration in pyproject.toml to ">=3.12, <3.15" to reflect the new minimum version, or revert the Sphinx dependency update to a version that still supports Python 3.11, such as sphinx<9.1.
🤖 Prompt for AI Agent
Review the code at the location below. A potential bug has been identified by an AI
agent.
Verify if this is a real issue. If it is, propose a fix; if not, explain why it's not
valid.
Location: pyproject.toml#L192
Potential issue: The project's `pyproject.toml` is being updated to require
`sphinx>=9.1,<10`. However, the official Sphinx 9.1.0 release dropped support for Python
3.11 and requires Python 3.12 or newer. The project's configuration still declares
support for Python 3.11 via `requires-python = ">=3.11, <3.15"`. This incompatibility
will cause a hard dependency resolution failure for any user attempting to install this
package on a Python 3.11 environment, preventing installation entirely.
Did we get this right? 👍 / 👎 to inform future reviews.
Reference ID: 8077303
This PR contains the following updates:
>=8.2.3,<9→>=9.1,<10Warning
Some dependencies could not be looked up. Check the Dependency Dashboard for more information.
Release Notes
sphinx-doc/sphinx (sphinx)
v9.1.0Compare Source
==============================
Dependencies
Patch by Adam Turner
Incompatible changes
Deprecated
Features added
~sphinx.application.Sphinx.add_static_dirfor copying staticassets from extensions to the build output.
Patch by Jared Dillard
Bugs fixed
:no-index-entry:for modules.Patch by Adam Turner
Patch by Adam Turner
Patch by Adam Turner
Patch by Adam Turner
Patch by Adam Turner
standard role.
Patch by Günter Milde
Patch by Tim Nordell
Patch by Tim Nordell
HTMLThemeFactoryobjects in third-party extensions.Patch by Adam Turner
circa 1350 codelines (about 27 a4-sized pages at default pointsize).
Patch by Jean-François B.
Patch by Jean-François B.
Patch by Adam Turner
3.5.0(#8854) of the documentation ofliteralblockcapposkey of :ref:'sphinxsetup' <latexsphinxsetup>.Patch by Jean-François B.
Testing
v9.0.4: Sphinx 9.0.4Compare Source
Changelog: https://www.sphinx-doc.org/en/master/changes/9.0.html
Bugs fixed
in strings, or use translated display text in references.
Patch by Matt Wang.
v9.0.3: Sphinx 9.0.3Compare Source
Changelog: https://www.sphinx-doc.org/en/master/changes/9.0.html
Bugs fixed
sphinx.ext.autodoc.Patch by Adam Turner.
v9.0.2: Sphinx 9.0.2Compare Source
Changelog: https://www.sphinx-doc.org/en/master/changes/9.0.html
Bugs fixed
sphinx.ext.autodoc.mock.Patch by Adam Turner.
v9.0.1: Sphinx 9.0.1Compare Source
Changelog: https://www.sphinx-doc.org/en/master/changes/9.0.html
Bugs fixed
Patch by Adam Turner.
Patch by Adam Turner.
v9.0.0: Sphinx 9.0.0Changelog: https://www.sphinx-doc.org/en/master/changes/9.0.html
Dependencies
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
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
Parserobjects.Patch by Adam Turner.
Parser.configandenvattributes.Patch by Adam Turner.
scheduled for removal in Sphinx 10.
Patch by Adam Turner.
sphinx.io.Sphinx no longer uses the
sphinx.ioclasses,having replaced them with standard Python I/O.
The entire
sphinx.iomodule will be removed in Sphinx 10.Patch by Adam Turner.
sphinx.environment.adapters.toctree.global_toctree_for_docand
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.overloadand
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.
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
mathjax_pathoption.Also add the new
mathjax4_configoption to configure MathJax v4.Note that MathJax v3 is mostly compatible with MathJax v4, so existing
mathjax3_configsettings should not need to change.Patch by Matthias Geier.
Patch by Matthieu de Cibeins.
Bugs fixed
longer result in spurious duplicate object description warnings.
Patch by Jeremy Maitin-Shepard.
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 forpy:deco.Patch by Shengyu Zhang and Adam Turner.
and PDF cannot be built.
Patch by Jean-François B.
(typically if
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.
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
FORWARDREFannotationlibformat.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.
Configuration
📅 Schedule: Branch creation - "before 2am every weekday" in timezone Europe/Berlin, 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.