Repository navigation
docs: upgrade Sphinx and validate documentation builds - #2165
Open
ChihweiLHBird wants to merge 11 commits into
Open
ChihweiLHBird wants to merge 11 commits into
ChihweiLHBird wants to merge 11 commits into
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## trunk #2165 +/- ##
=======================================
Coverage 83.60% 83.61%
=======================================
Files 352 352
Lines 82138 82161 +23
Branches 8814 8816 +2
=======================================
+ Hits 68671 68694 +23
Misses 10594 10594
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
tisonkun
reviewed
Sep 16, 2026
Comment on lines
-28
to
-29
| # NOTE: We need to use older version of sphinx otherwise bullet points won't be rendered correctly | ||
| # on RTD using rtd theme. |
Member
There was a problem hiding this comment.
@ChihweiLHBird Do you verify this note is no longer relevant? If so, may you provide a screenshot or recording as evidence.
Contributor
Author
There was a problem hiding this comment.
Yes, I verified this is no longer an issue. And double checked today for the bullet points thing:
Contributor
|
Hi @tisonkun, so do you agree with this PR? |
The decomposed caron in a contributor name stops pdflatex with an unsupported Unicode character error. Use the canonically equivalent precomposed character so the name renders correctly in the PDF.
The documentation job only exercises HTML even though Read the Docs publishes PDF and EPUB. Add a separate tox environment and install the LaTeX dependencies needed to build both downloadable formats.
tisonkun
changed the title
tisonkun
approved these changes
Nov 8, 2026
tisonkun
left a comment
tisonkun
left a comment
Member
There was a problem hiding this comment.
I pushed some follow-ups and it should work well now.
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 from 6.2.1 to 8.1.3, sphinx_rtd_theme from 2.0.0 to 3.1.0, and docutils from 0.19 to 0.21.2. This removes the old Sphinx dependency on AST classes removed in Python 3.14 while retaining support for Python 3.10; Sphinx 8.2 and later require Python 3.11 or newer.
Synchronize uv.lock with the dependency groups and use
uv sync --lockedfor Read the Docs and the documentation CI job so stale lockfiles fail explicitly. Remove the obsolete theme workaround and rely on automatic theme discovery.Add a
docs-formatstox environment and CI coverage for PDF and EPUB, including the required LaTeX packages. Normalize a decomposed accent in a changelog contributor's name so the existing PDF engine can render it.Validation:
tox -e docs-formatson Ubuntu 22.04 with Python 3.12.uv lock --check, rstcheck for README/CHANGES/CONTRIBUTING, and formatting checks.