Fix ReadTheDocs build config: deprecated OS image, stale Python pin - #836
Merged
Merged
Conversation
ReadTheDocs builds have been failing near-instantly (~2s, a config-level failure, not a real Sphinx error) since setup.py's python_requires was bumped to >=3.9 (PR QData#833). Two problems: - build.os was pinned to ubuntu-20.04, which ReadTheDocs has since deprecated. - build.tools.python was pinned to "3.8", which no longer satisfies textattack's own python_requires >=3.9 when the docs build installs the package itself (python.install's `path: .` entry). Bumped to ubuntu-24.04 / Python 3.11, matching what .github/workflows/make-docs.yml already uses successfully in CI. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
3 tasks
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.
Summary
Fixes ReadTheDocs builds, which have been failing near-instantly (~2s — a config-level failure, not a real Sphinx/doc content error) since
setup.py'spython_requireswas bumped to>=3.9in #833.Problems
.readthedocs.yaml'sbuild.oswas pinned toubuntu-20.04, which ReadTheDocs has since deprecated.build.tools.pythonwas pinned to"3.8", which no longer satisfiestextattack's ownpython_requires >= 3.9— the docs build installs the package itself (python.install'spath: .entry), so this fails at dependency resolution.Fix
Bumped to
ubuntu-24.04/ Python3.11, matching what.github/workflows/make-docs.ymlalready uses successfully in CI (that job builds the same Sphinx docs and passes).Verification
stablebuilds are failing withduration: 2seconds (consistent with an early config/install failure, not a Sphinx content error)🤖 Generated with Claude Code