From cb89d67b1beb55c7c5b2cc7689e6fc061b5759e3 Mon Sep 17 00:00:00 2001 From: Jammy2211 Date: Thu, 9 Jul 2026 21:47:47 +0100 Subject: [PATCH 1/2] =?UTF-8?q?docs:=20RTD=20hygiene=20=E2=80=94=20fix=20n?= =?UTF-8?q?numpydoc=20typo,=20prune=20conf.py,=20add=20docs=20CI?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 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 Claude-Session: https://claude.ai/code/session_01GziFkivBHz1d11eFYUszmy --- .github/workflows/docs.yml | 31 +++++++++++++++++++++++++++++++ .gitignore | 1 + docs/conf.py | 12 +----------- docs/sphinx_warning_baseline.txt | 1 + 4 files changed, 34 insertions(+), 11 deletions(-) create mode 100644 .github/workflows/docs.yml create mode 100644 docs/sphinx_warning_baseline.txt diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml new file mode 100644 index 000000000..c5ceca992 --- /dev/null +++ b/.github/workflows/docs.yml @@ -0,0 +1,31 @@ +name: Docs + +# Docs build check is defined once, centrally, in PyAutoHeart's reusable +# workflow (Heart owns all health/readiness checking). This thin caller +# builds the Sphinx docs on PRs and fails on warning-count regression +# against docs/sphinx_warning_baseline.txt. + +on: + push: + branches: [main] + paths: + - "docs/**" + - "autolens/**" + - "pyproject.toml" + - ".readthedocs.yaml" + - ".github/workflows/docs.yml" + pull_request: + paths: + - "docs/**" + - "autolens/**" + - "pyproject.toml" + - ".readthedocs.yaml" + - ".github/workflows/docs.yml" + workflow_dispatch: + +jobs: + docs: + uses: PyAutoLabs/PyAutoHeart/.github/workflows/docs-build.yml@main + with: + package: autolens + secrets: inherit diff --git a/.gitignore b/.gitignore index e5f27da06..184ed2074 100644 --- a/.gitignore +++ b/.gitignore @@ -66,3 +66,4 @@ docs/_templates docs/generated docs/api/generated autolens_workspace_test/ +docs/api/_autosummary diff --git a/docs/conf.py b/docs/conf.py index d6b4dd528..7549d313e 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -90,7 +90,7 @@ numpydoc_show_class_members = False numpydoc_show_inherited_class_members = False -nnumpydoc_class_members_toctree = True +numpydoc_class_members_toctree = True # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. @@ -122,18 +122,8 @@ pygments_dark_style = "monokai" add_function_parentheses = False -html_context = { - "menu_links_name": "Repository", - "doc_path": "docs", - "github_project": "pyautolens", - "github_repo": "pyautolens", - "github_version": "master", -} language = "en" -html_static_path = ["_static"] -html_css_files = ["pied-piper-admonition.css"] - html_theme_options = { "light_css_variables": { "color-brand-primary": "#7C4DFF", diff --git a/docs/sphinx_warning_baseline.txt b/docs/sphinx_warning_baseline.txt new file mode 100644 index 000000000..405e2afe8 --- /dev/null +++ b/docs/sphinx_warning_baseline.txt @@ -0,0 +1 @@ +134 From 1f0b7a5095edf35c1508732ff940fc696f1ed6a6 Mon Sep 17 00:00:00 2001 From: Jammy2211 Date: Thu, 9 Jul 2026 22:20:06 +0100 Subject: [PATCH 2/2] ci: retrigger docs check after PyAutoHeart#48 (docs-build.yml now on main)