Repository navigation
Remove the Sphinx static CSS copy workaround - #2951
Merged
Merged
Conversation
Sphinx's incremental builds didn't copy changed CSS files, so the docs had an opt-in workaround (util/sphinx_static_file_temp_fix.py, enabled by a .ENABLE_DEVMACHINE_SPHINX_STATIC_FIX file). Sphinx fixed this upstream, and the pinned Sphinx 9.1.0 copies changed CSS without it (#2266). Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
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
1 participant
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.
Summary
Fixes #2266 by removing the workaround for it, now that Sphinx has fixed the bug upstream.
make.py serveand incrementalmake.py htmlbuilds didn't copy changed CSS files fromdoc/_static, so style changes didn't show until a clean build. The docs had an opt-in workaround:util/sphinx_static_file_temp_fix.py, which ran during every build and acted only if a.ENABLE_DEVMACHINE_SPHINX_STATIC_FIXfile existed.Sphinx fixed this upstream, and pyproject pins Sphinx 9.1.0.
Checked without the workaround
.ENABLE_DEVMACHINE_SPHINX_STATIC_FIXfile.doc/_static/css/custom.css.make.py serveruns on each change.The marker reached the built
_static/css/custom.cssevery time: over three rounds of editing, and again after this PR's changes toconf.py.Removed
util/sphinx_static_file_temp_fix.py.run_util(...)call and a related "pending" comment indoc/conf.py..ENABLE_DEVMACHINE_SPHINX_STATIC_FIXentry in.gitignore.Not covered
A comment on the issue says example thumbnails don't regenerate when screenshots change. That's separate, and I didn't test it.
Checks
The docs build passes, with the same 8 warnings as on development. The changelog has an entry under Unreleased → Misc Changes.
🤖 Generated with Claude Code