Drop the archived readthedocs-sphinx-ext, which breaks the docs build on Sphinx 8.2+ - #1327
Open
dylanpulver wants to merge 1 commit into
Open
dylanpulver wants to merge 1 commit into
dylanpulver wants to merge 1 commit into
Conversation
Its update_body reads app.builder.css_files, removed from Sphinx builders in 8.2, so every docs build fails once pip resolves a current Sphinx. The package is archived upstream, so it will not be fixed, and CLIMADA uses sphinx-book-theme rather than sphinx_rtd_theme, so the CSS the extension exists to inject was never wanted here. Read the Docs Addons injects the flyout and search itself. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_011M5uTyCU4WcNTsPvGrErDo
dylanpulver
requested review from
chahank,
emanuel-schmid and
peanutfun
as code owners
September 28, 2026 00:37
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.
The Read the Docs build is failing on current PRs, and it will fail on every new one.
readthedocs-sphinx-extruns this on each page:css_fileswas removed from Sphinx's HTML builders, so the attribute access raises before thesphinx.version_info < (1, 8)guard below it can help. Sincedocpinsreadthedocs-sphinx-ext>=2.2but leavessphinxunpinned, each build resolves a newer Sphinx and dies:That is build 34785300 verbatim, and it reproduces locally with
.[doc]anddoc/conf.pyunchanged.Bisected against the extension at 2.2.5: Sphinx 8.1.3 builds, 8.2.3 and everything after fails.
Why remove it rather than pin Sphinx. The extension is archived upstream, so it will not be fixed and a pin would hold CLIMADA on Sphinx 8.1 indefinitely. Its job is injecting
sphinx_rtd_themeorbadge_onlyCSS plus the old doc-embed JS; CLIMADA usessphinx-book-theme, so that CSS was never wanted here, and Read the Docs Addons injects the flyout and search itself now. Nothing underdoc/referencesreadthedocs_build,readthedocs_extor those assets, andconf.py's ownreadthedocsconfig value is declared in itssetup()and is unaffected.With the extension dropped, the same command Read the Docs runs succeeds:
No warning mentions Read the Docs or CSS, and the warning count is what the build already carried.
🤖 Generated with Claude Code
https://claude.ai/code/session_011M5uTyCU4WcNTsPvGrErDo