From 630587696e3ca2f79a8a4f3181277b6a34ee3ad8 Mon Sep 17 00:00:00 2001 From: Jammy2211 Date: Fri, 6 Nov 2026 10:15:28 +0000 Subject: [PATCH] audit_docs: cover PyAutoCTI (its docs/api drifted 53 dead entries unaudited) Refs PyAutoLabs/PyAutoCTI#123 Co-Authored-By: Claude Opus 5.5 --- skills/audit_docs/SKILL.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/skills/audit_docs/SKILL.md b/skills/audit_docs/SKILL.md index d67af3b..839e9a5 100644 --- a/skills/audit_docs/SKILL.md +++ b/skills/audit_docs/SKILL.md @@ -3,14 +3,14 @@ name: audit-docs description: Audit docs/api/*.rst files across repos for broken module paths, missing classes, and stale autosummary entries. --- -Scan Sphinx API documentation across PyAutoFit, PyAutoGalaxy, and PyAutoLens for broken `.. currentmodule::` paths and stale `.. autosummary::` class references. Optionally auto-fix broken entries. +Scan Sphinx API documentation across PyAutoFit, PyAutoGalaxy, PyAutoLens, and PyAutoCTI for broken `.. currentmodule::` paths and stale `.. autosummary::` class references. Optionally auto-fix broken entries. A **PyAutoHeart** check — documentation correctness is part of the validation surface Heart owns. The audit is read-only; auto-fix is opt-in and confined to the docs files it flags. ## Usage ``` -$audit-docs # audit all three repos (default) +$audit-docs # audit all four repos (default) $audit-docs PyAutoLens # audit one repo $audit-docs PyAutoGalaxy PyAutoFit # audit specific repos $audit-docs --fix # audit all repos and auto-fix broken references @@ -26,6 +26,7 @@ In Claude, invoke the same skill as `/audit_docs`. | `PyAutoFit` | `./PyAutoFit/docs/api/` | | `PyAutoGalaxy` | `./PyAutoGalaxy/docs/api/` | | `PyAutoLens` | `./PyAutoLens/docs/api/` | +| `PyAutoCTI` | `./PyAutoCTI/docs/api/` | All paths are relative to the workspace root. @@ -33,7 +34,7 @@ All paths are relative to the workspace root. ### 1. Determine which repos to audit -- **Default: audit ALL three repos.** Cross-package references (e.g. PyAutoLens docs referencing autoarray modules) mean a change in one library can break another library's docs. +- **Default: audit ALL four repos.** Cross-package references (e.g. PyAutoLens docs referencing autoarray modules) mean a change in one library can break another library's docs. - Only audit a subset if the user explicitly passes repo names as arguments. ### 2. Parse RST files @@ -155,6 +156,7 @@ gh issue comment --repo --body "$(cat <<'AUDIT_EOF' | PyAutoFit | X | Y | X | Y | Z | | PyAutoGalaxy | X | Y | X | Y | Z | | PyAutoLens | X | Y | X | Y | Z | +| PyAutoCTI | X | Y | X | Y | Z |
AUDIT_EOF