Infra: bump Sphinx to 9.0+, limit docutils to <0.22#4926
Conversation
|
Let's not set a higher version than needed, but if we have a good reason for bumping it, I think that's fine. Something to note, Sphinx does drop older Python sooner than many projects. For example, Sphinx 9.1.0 requires Python 3.12 or newer. But then people writing PEPs are targeting changes in 3.15 and soon 3.16 :) |
842b11d to
cef97cb
Compare
|
Ok, I have set the Sphinx requirement to |
77b6167 to
c9ffc7f
Compare
hugovk
left a comment
There was a problem hiding this comment.
RTD:
Index file is not present in HTML output directory Your documentation did not generate an index.html at its root directory. This is required for documentation serving at the root URL for this version.
Try this in pep_html_builder.py:
name = DirectoryHTMLBuilder.name
get_target_uri = DirectoryHTMLBuilder.get_target_uri
- get_outfilename = DirectoryHTMLBuilder.get_outfilename
+ get_output_path = DirectoryHTMLBuilder.get_output_pathRelated to sphinx-doc/sphinx#13045.
| Sphinx >= 5.1.1, != 6.1.0, != 6.1.1, < 8.1.0 | ||
| docutils >= 0.19.0 | ||
| Sphinx > 9.0 | ||
| docutils >= 0.19.0, < 0.22 |
There was a problem hiding this comment.
Only the upper bound is important here, Sphinx already sets docutils>=0.21,<0.23:
| 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.
| # 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 |
There was a problem hiding this comment.
I think we can do Sphinx 8.2 or greater?
| Sphinx > 9.0 | |
| Sphinx >= 8.2 |
Blocked by: #4908, #4906Closes: #4087
Bump Sphinx to 9.0+ (9.2 at the moment).
docutilsis upper-limited because of build errors listed in #4924.The
mvindirhtmlstep in theMakefileis no longer needed, since the 404 page builds as404.html.📚 Documentation preview 📚: https://pep-previews--4926.org.readthedocs.build/