Skip to content

audit_docs: cover PyAutoCTI #324

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Jammy2211 merged 1 commit into from
Nov 6, 2026
+5 −3
Merged

audit_docs: cover PyAutoCTI #324

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions skills/audit_docs/SKILL.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -26,14 +26,15 @@ 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.

## Steps

### 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
Expand Down Expand Up @@ -155,6 +156,7 @@ gh issue comment <number> --repo <owner/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 |

<details if any failures>
AUDIT_EOF
Expand Down
Loading