docs: RTD hygiene — fix nnumpydoc typo, prune conf.py, add docs CI#597
Merged
Conversation
Phase A of the docs-infrastructure census (PyAutoLabs/PyAutoFit#1341): - docs/conf.py: fix the nnumpydoc_class_members_toctree typo (setting was silently ignored; True is numpydoc's default, so rendering is unchanged — the intent is now explicit); remove the dead html_context block (never read by Furo); drop html_static_path/html_css_files pointing at a pied-piper-admonition.css that never existed in history (removes the html_static_path build warning) - 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 134) - .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
Phase A of the docs-infrastructure census (PyAutoLabs/PyAutoFit#1341): fixes the
nnumpydoc_class_members_toctreetypo indocs/conf.py(the setting was silently ignored;Trueis numpydoc's default so rendering is unchanged — the intent is now explicit), removes the deadhtml_contextblock (never read by Furo), dropshtml_static_path/html_css_filespointing at apied-piper-admonition.cssthat never existed in the repo's history (removes a real build warning), extends.gitignorewithdocs/api/_autosummary, 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(134).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
_staticwarning; rendered pages text-identicaldocscheck 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:
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