Skip to content
This repository was archived by the owner on Jan 14, 2026. It is now read-only.

⬆️ 🛠️(deps): update dependency sphinx to v9 #2307

Closed
renovate wants to merge 1 commit into from
Closed

⬆️ 🛠️(deps): update dependency sphinx to v9 #2307

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ dev = [
"pre-commit~=4.0",

@llamapreview llamapreview Bot Dec 30, 2025

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[Contextual Comment]
This comment refers to code near real line 30. Anchored to nearest_changed(72) line 72.

P2 | Confidence: High

The Sphinx 9.0.0 release follows Sphinx 8.x, which dropped support for Python 3.9. The project's pyproject.toml correctly declares support for Python 3.10, 3.11, and 3.12, which aligns with Sphinx 9.x's requirements. This is a positive architectural alignment finding, confirming the version upgrade does not introduce a Python version incompatibility for the declared support matrix.

]
docs = [

@llamapreview llamapreview Bot Dec 30, 2025

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 | Confidence: High

Speculative: This major version upgrade from Sphinx 7.4.7 to 9.0.0 includes several documented breaking changes, notably a substantial rewrite of sphinx.ext.autodoc and removal of deprecated APIs. The related context confirms Sphinx is actively used for documentation builds via docs/conf.py, docs/.readthedocs.yaml, and docs/Makefile. While the immediate change is a version pin, the architectural impact is that the documentation build process may fail or produce different output due to incompatible changes in autodoc behavior (requiring autodoc_use_legacy_class_based), stricter source encoding handling (non-UTF-8 now errors), and deprecated internal APIs. The failure is not guaranteed but is a high-probability risk for any non-trivial Sphinx configuration.

P2 | Confidence: Medium

Speculative: The PR updates the core sphinx dependency but does not review the compatibility of the associated documentation toolchain extensions (sphinx-hoverxref, sphinx_copybutton, sphinx_design, myst_parser, pydata-sphinx-theme). Sphinx 9.0.0's internal changes (especially in sphinx.io and parser APIs) may cause these extensions to break if they rely on deprecated interfaces. The related context does not show direct extension usage, but their presence in the dependency list indicates they are integral to the documentation build. This creates a risk of a broken documentation build even if the core Sphinx update succeeds.

"sphinx==7.4.7", # Pinned
"sphinx==9.0.4", # Pinned
"sphinx-hoverxref~=1.3",
"sphinx_copybutton==0.5.2", # Pinned
"sphinx_design~=0.6",
Expand Down
Loading