Skip to content

docs: prune stale API-doc references#492

Merged
Jammy2211 merged 1 commit into
mainfrom
feature/release-docs-polish-learn-paths
Jul 9, 2026
Merged

docs: prune stale API-doc references#492
Jammy2211 merged 1 commit into
mainfrom
feature/release-docs-polish-learn-paths

Conversation

@Jammy2211

Copy link
Copy Markdown
Collaborator

Summary

Phase A of the release-docs polish (PyAutoLabs/PyAutoLens#592) — API-doc cleanup for PyAutoGalaxy.

Prunes docs/api/*.rst autosummary entries for removed API:

  • the OO plotting subsystem (MatPlot2D/Cmap/*Scatter wrappers, replaced by the functional plot API) — removed the "Plot Customization" + "Matplotlib Wrappers" sections from plot.rst;
  • PySwarmsLocal/PySwarmsGlobal, AdaptImageMaker (kept AdaptImages) in modeling.rst;
  • SettingsImaging/SettingsInterferometer and a duplicate Convolver in data.rst.

Re-audit reports zero broken/missing/duplicate references. The functional-API plot.rst rewrite is a filed follow-up.

Validation checklist (--auto, supervised)

  • Tests: n/a — zero Python source changed (docs/api/*.rst only).
  • Smoke: n/a — no downstream script surface in this repo's diff.
  • Review: CLEAN — re-audit confirms every remaining autosummary reference resolves; CRLF preserved (byte-safe edits).
  • Heart: YELLOW — reason set human-acknowledged at ship (5 chronic organism reasons; none from this change, none RED).

Autonomous run ended at PR-open; merge stays human. Library-first gate: this + PyAutoLens#593 merge before the autolens_workspace PR.

Part of PyAutoLabs/PyAutoLens#592.

🤖 Generated with Claude Code

Remove docs/api/*.rst autosummary entries for removed API: the OO
plotting subsystem (MatPlot2D/Cmap/*Scatter wrappers, replaced by the
functional plot API), PySwarms searches, AdaptImageMaker, SettingsImaging/
Interferometer, and a duplicate Convolver entry. Re-audit clean.

Issue PyAutoLabs/PyAutoLens#592.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@Jammy2211 Jammy2211 added the pending-release PR queued for the next release build label Jul 9, 2026
@Jammy2211 Jammy2211 merged commit 6f50e73 into main Jul 9, 2026
4 checks passed
@Jammy2211 Jammy2211 deleted the feature/release-docs-polish-learn-paths branch July 9, 2026 15:38
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