Skip to content

Infra: bump Sphinx to 9.0+, limit docutils to <0.22 #4926

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
Secrus wants to merge 1 commit into
base: main
Choose a base branch
from
+2 −5
Draft

Infra: bump Sphinx to 9.0+, limit docutils to <0.22 #4926

Show file tree
Hide file tree
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
1 change: 0 additions & 1 deletion Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,6 @@ htmllive: _ensure-sphinx-autobuild html
.PHONY: dirhtml
dirhtml: BUILDER = dirhtml
dirhtml: html
mv $(BUILDDIR)/404/index.html $(BUILDDIR)/404.html

## search to rebuild the search index
.PHONY: search
Expand Down
6 changes: 2 additions & 4 deletions requirements.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,8 @@
# https://github.com/pygments/pygments/discussions/3145
pygments @ git+https://github.com/pygments/pygments@2cad2642058441b59782a6a18f03c98c42d081f1

# Sphinx 6.1.0 broke copying images in parallel builds; fixed in 6.1.2
# See https://github.com/sphinx-doc/sphinx/pull/11100
Sphinx >= 5.1.1, != 6.1.0, != 6.1.1, < 8.1.0
docutils >= 0.19.0
Sphinx > 9.0

@hugovk hugovk Jul 24, 2026 •
edited
Loading

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I think we can do Sphinx 8.2 or greater?

Suggested change
Sphinx > 9.0
Sphinx >= 8.2

docutils >= 0.19.0, < 0.22

@hugovk hugovk Jul 24, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Only the upper bound is important here, Sphinx already sets docutils>=0.21,<0.23:

Suggested change
docutils >= 0.19.0, < 0.22
docutils < 0.22

And include a comment on why we need an upper bound? Something like pending sphinx-doc/sphinx#14455.

sphinx-notfound-page >= 1.0.2
# For search
pagefind[bin] >= 1.5.0
Expand Down
Loading