docs: RTD hygiene — delete dead configs, converge conf.py, add docs CI#1342
Merged
Conversation
Phase A of the docs-infrastructure census (#1341), PyAutoFit leg: - delete readthedocs.yml (dead duplicate of .readthedocs.yaml, drifted to py3.11; RTD only reads the dotfile) and docs/requirements.txt (dead — RTD installs the pyproject [docs] extra; the file pinned ancient deps like SQLAlchemy==1.3.20 while looking authoritative) - docs/conf.py: converge on the PyAutoGalaxy/PyAutoLens variant — enable sphinx_autodoc_typehints (shipped in the [docs] extra but never enabled), adopt autodoc_default_options / autodoc_class_signature="separated" / autoclass_content="init" / autosummary_imported_members=True / add_module_names=False and the typehints settings; fix numpydoc_class_members_toctree to the shared value (True); remove the dead html_context block (never read by Furo) and the phantom html_static_path/pied-piper-admonition.css refs (docs/_static is gitignored here — the asset never existed) - add .github/workflows/docs.yml — thin caller into PyAutoHeart's reusable docs-build workflow (PyAutoHeart#48); fails on Sphinx warning-count regression against docs/sphinx_warning_baseline.txt (67: 63 before, -2 removed, +6 typehints forward-reference warnings surfaced by the newly enabled extension) - .gitignore: also ignore 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
Closes the PyAutoFit leg of #1341 (phase A of the docs-infrastructure census). Deletes
readthedocs.yml(dead py3.11 duplicate — RTD only reads.readthedocs.yaml) anddocs/requirements.txt(dead — RTD installs the pyproject[docs]extra; the file pinned ancient deps likeSQLAlchemy==1.3.20while looking authoritative). Convergesdocs/conf.pyon the Galaxy/Lens variant: enablessphinx_autodoc_typehints(shipped in the[docs]extra but never enabled), adopts the shared autodoc/numpydoc/typehints settings, removes the deadhtml_contextblock and the phantom_staticCSS refs. Adds thedocsCI check (thin caller into PyAutoHeart'sdocs-build.yml, merged in PyAutoHeart#48) gated ondocs/sphinx_warning_baseline.txt(67).Note this leg changes API-page rendering by design (separated class signatures,
__init__-content classes, imported members documented — matching how Galaxy/Lens docs render). Verified locally: 29 autosummary pages generate,autofit.Modelpage renders complete with Parameters section.This does not fix the dead RTD site by itself — pyautofit.readthedocs.io has not built since 2026-05-06 because the RTD project still points at
rhayes777/PyAutoFit.git; the dashboard reconnection (human leg on #1341) is what revives it.API Changes
None — docs/CI configuration only.
Test Plan
_static, −1 docutils artifact, +6 typehints forward-reference warnings surfaced by the newly enabled extension — pre-existing TYPE_CHECKING-guarded annotation debt, now visible)docscheck green on this PR (baseline 67; Galaxy/Lens baselines held exactly in CI, so no recalibration expected)Validation checklist (--auto run)
Full API Changes (for automation & release notes)
None — files touched:
readthedocs.yml(deleted),docs/requirements.txt(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