Skip to content

Fix ReadTheDocs build config: deprecated OS image, stale Python pin - #836

Merged
qiyanjun merged 1 commit into
QData:masterfrom
qiyanjun:fix/readthedocs-config
Aug 14, 2026
Merged

qiyanjun merged 1 commit into
QData:masterfrom
qiyanjun:fix/readthedocs-config

Conversation

@qiyanjun

Copy link
Copy Markdown
Member

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's python_requires was bumped to >=3.9 in #833.

Problems

  • .readthedocs.yaml's 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 — the docs build installs the package itself (python.install's path: . entry), so this fails at dependency resolution.

Fix

Bumped to ubuntu-24.04 / Python 3.11, matching what .github/workflows/make-docs.yml already uses successfully in CI (that job builds the same Sphinx docs and passes).

Verification

  • Confirmed via ReadTheDocs's public build API that recent stable builds are failing with duration: 2 seconds (consistent with an early config/install failure, not a Sphinx content error)
  • YAML syntax validated
  • Matches the Python version CI's own (passing) docs-build job already uses

🤖 Generated with Claude Code

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>
@qiyanjun
qiyanjun merged commit 2ab4f5e into QData:master Aug 14, 2026
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant