-
Notifications
You must be signed in to change notification settings - Fork 352
Remove temp fix for Sphinx _static file bug #2709
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.
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
base: development
Are you sure you want to change the base?
Conversation
* Remove util/sphinx_static_file_temp_fix and invocation in conf.py * Upgrade to Sphinx 8.2.3 to include fix for temp files * Add mention of requiring Python 3.11 as comments in pyproject.toml * Update Python versions for CI doc build (readthedocs + GitHub) * Explain the contents of the dev deps
Test instructionsPlease report:
To get started, first make sure you have Python >= 3.11 in an activated virtual environment. Time a clean build"Does it run fast enough on clean build?"
Ensure static file copy worksi.e. "Does Sphinx now handle CSS changes correctly?"
|
|
This changes breaks installation via uv:
|
How did we have anything work in the past?
|
I always had to change the required python to 3.10 and remember to not commit it to github. |
Dev dependencies could be moved out of the toml if needed (or maybe just doc reqs). The issues it creates for uv is pretty serious and we shouldn't break it. |
do we really require 3.11 for docs? Is there no easy way around it? :/ |
TL;DR: We can make things easier at the cost of tech debt, but we've still gotta deal with Sphinx :(
I think einarf and I have both have ideas to make it better. The "Easy" Way?
I'll see what I can do to improve our This But first, we need to:
Why do all that?It makes room for nice things! They could include:
I don't like the last approach as much, but it should work. ... The Non-Easy Way?TL;DR: Moving away first from ReST, then from Sphinx. But that's a mega-project of its own. |
TL;DR: Remove temp fix for Sphinx
_static
bug + add--jobs
flag for./make.py html
and./make.py serve
Performance?
Warning
This bumps min developer Py to 3.11 and it needs testing to ensure performance issues are solved!
In-depth test instructions are located in a comment below. Current test status:
We can continue using the temp fix until we're sure this PR's good.
Wait, What Changed in Sphinx 8.2.X?
Seems like:
I've brought the first-time build down by adding a
--jobs
/-j
flag pass-through to./make.py
. It seems to restore perf (now under 10 min, was 45+ minutes), but Sphinx's parallelism might not work correctly on Windows:What's Changed