Skip to content

docs: RTD hygiene — delete dead configs, converge conf.py, add docs CI#1342

Merged
Jammy2211 merged 1 commit into
mainfrom
feature/rtd-hygiene
Jul 9, 2026
Merged

docs: RTD hygiene — delete dead configs, converge conf.py, add docs CI#1342
Jammy2211 merged 1 commit into
mainfrom
feature/rtd-hygiene

Conversation

@Jammy2211

Copy link
Copy Markdown
Collaborator

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) and docs/requirements.txt (dead — RTD installs the pyproject [docs] extra; the file pinned ancient deps like SQLAlchemy==1.3.20 while looking authoritative). Converges docs/conf.py on the Galaxy/Lens variant: enables sphinx_autodoc_typehints (shipped in the [docs] extra but never enabled), adopts the shared autodoc/numpydoc/typehints settings, removes the dead html_context block and the phantom _static CSS refs. Adds the docs CI check (thin caller into PyAutoHeart's docs-build.yml, merged in PyAutoHeart#48) gated on docs/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.Model page 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

  • PyAutoFit suite: 1424 passed, 14 skipped (full, worktree)
  • Sphinx before/after: 63 → 67 warnings; delta fully explained (−1 phantom-_static, −1 docutils artifact, +6 typehints forward-reference warnings surfaced by the newly enabled extension — pre-existing TYPE_CHECKING-guarded annotation debt, now visible)
  • docs check green on this PR (baseline 67; Galaxy/Lens baselines held exactly in CI, so no recalibration expected)

Validation checklist (--auto run)

  • Effective level: supervised (header: supervised, cap: docs ≤ medium → safe)
  • Plan: on the issue (docs: RTD hygiene — reconnect PyAutoFit RTD, converge conf.py, add docs CI #1341), written at start; this leg unlocked by the human's in-session claim override ("they don't clash") — disjointness verified against ep-diagnostics (9 files, non_linear/diagnostics area) and ep-graphical-docs PR#1334 (graphical/messages/AGENTS.md): zero file overlap with this diff
  • Gate: tests 1424 pass / 14 skip · smoke n/a (docs+CI only) · review CLEAN · Heart YELLOW within in-session ack (reason set re-checked at this ship — identical to the acked list)
  • Human: plan sound in hindsight?
  • Human: diff matches plan (no scope creep)?
  • Human: merge, amend, or reject — then log the outcome
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

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
@Jammy2211 Jammy2211 added the pending-release PR queued for the next release build label Jul 9, 2026
@Jammy2211 Jammy2211 merged commit 7f58d5e into main Jul 9, 2026
6 checks passed
@Jammy2211 Jammy2211 deleted the feature/rtd-hygiene branch July 9, 2026 21:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

pending-release PR queued for the next release build

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant