Upgrade Sphinx docs toolchain (6.2.1 → 8.1.3) - #2165
Open
ChihweiLHBird wants to merge 4 commits into
Open
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## trunk #2165 +/- ##
=======================================
Coverage 83.58% 83.58%
=======================================
Files 352 352
Lines 81808 81808
Branches 8769 8769
=======================================
Hits 68373 68373
Misses 10562 10562
Partials 2873 2873 🚀 New features to boost your workflow:
|
ChihweiLHBird
marked this pull request as draft
July 21, 2026 03:46
Contributor
Author
|
|
ChihweiLHBird
marked this pull request as ready for review
July 21, 2026 13:45
ChihweiLHBird
marked this pull request as draft
July 21, 2026 13:46
Signed-off-by: Zhiwei Liang <zhiwei.liang@zliang.me>
ChihweiLHBird
force-pushed
the
zhiwei/upgrade-sphinx
branch
from
July 21, 2026 13:54
656053c to
4e1a1cd
Compare
ChihweiLHBird
marked this pull request as ready for review
July 21, 2026 13:54
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Upgrade Sphinx docs toolchain (6.2.1 → 8.1.3)
What
Modernize the
docsdependency group and sync the lockfile:Why
sphinx==6.2.1cannot run on Python 3.12+ (ast.Str, removed in 3.12), blocking local doc builds on modern interpreters.8.1.3is the newest Sphinx that still supports the project's minimum Python (3.10), sorequires-pythonis unchanged.sphinx_rtd_theme==3.1.0supports Sphinx 6–9 and constrainsdocutils<0.23.Changes
pyproject.toml— bump thedocsgroup as above.uv.lock— regenerated to match (RTD/CI useuv sync --frozen, which fails on a stale lock)..readthedocs.yml— removed the obsolete note about pinning an older Sphinx to fix bullet-point rendering. That was asphinx_rtd_theme < 1.0/docutils >= 0.17issue, long fixed in the current theme.