docs: RTD hygiene — delete dead readthedocs.yaml, prune conf.py, add docs CI#495
Merged
Conversation
…docs CI Phase A of the docs-infrastructure census (PyAutoLabs/PyAutoFit#1341): - delete readthedocs.yaml (dead duplicate of .readthedocs.yaml, drifted to py3.11; RTD only reads the dotfile) - docs/conf.py: remove the dead html_context block (sphinx_rtd_theme-era, never read by Furo) - add .github/workflows/docs.yml — thin caller into PyAutoHeart's reusable docs-build workflow; fails on Sphinx warning-count regression against docs/sphinx_warning_baseline.txt (currently 105) - .gitignore: Sphinx build artifacts (docs/_build, docs/api/generated, docs/api/_autosummary) Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01GziFkivBHz1d11eFYUszmy
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
Phase A of the docs-infrastructure census (PyAutoLabs/PyAutoFit#1341): deletes the dead
readthedocs.yaml(drifted py3.11 duplicate — RTD only reads.readthedocs.yaml), removes the deadhtml_contextblock fromdocs/conf.py(sphinx_rtd_theme-era, never read by Furo), gitignores Sphinx build artifacts (docs/_build,docs/api/generated,docs/api/_autosummary— my local builds showed they were never ignored), and adds adocsCI check as a thin caller into PyAutoHeart's new reusabledocs-build.yml(PyAutoHeart#48), gated on warning-count regression againstdocs/sphinx_warning_baseline.txt(105).Merge order: PyAutoHeart#48 merges first — the
docscheck here errors with "workflow not found" until it lands.API Changes
None — docs/CI configuration only.
Test Plan
docscheck green on this PR (baseline measured locally; one-time CI recalibration allowed with justification)Validation checklist (--auto run)
Full API Changes (for automation & release notes)
None — files touched:
readthedocs.yaml(deleted),docs/conf.py,.gitignore,.github/workflows/docs.yml(new),docs/sphinx_warning_baseline.txt(new).🤖 Generated with Claude Code
https://claude.ai/code/session_01GziFkivBHz1d11eFYUszmy