Affected Repositories

• PyAutoCTI (primary)
• PyAutoHeart

Branch Survey

Suggested branch: feature/cti-api-rst-rewrite

Audit today (2026-11-06)

• plot.rst: 48 dead
• data.rst: 5 dead (Grid2D, Grid2DIrregular, Grid1D, LayoutDataset1D, SettingsDataset1D)
• modeling.rst: 0 (the PySwarms entries were already removed)
• arctic, clocking, fitting: clean

Implementation Steps

1. docs/api/plot.rst: an introduction to the functional API with an import autocti.plot as aplt example (mirroring PyAutoFit/docs/api/plot.rst), then sections:
   • Dataset 1D: figure_dataset_1d_data, subplot_dataset_1d, subplot_dataset_1d_list
   • Fit 1D: figure_fit_dataset_1d, subplot_fit_dataset_1d, subplot_fit_dataset_1d_list, fits_fit_dataset_1d
   • Charge injection imaging: the *_imaging_ci_* functions plus figure_pre_cti_data_residual_map
   • Fit CI: the *_fit_ci_* functions plus subplot_noise_scaling_map_dict
   • General: plot_array, plot_yx, plot_cti_1d, subplot_save
   • Search plots: the autofit corner_cornerpy, corner_anesthetic, subplot_parameters, log_likelihood_vs_iteration
   • Output: output_figure
   • Visualization during a fit: PlotterDataset1D, PlotterImagingCI
2. docs/api/data.rst: remove the 3 Grid entries and the grid wording, rename LayoutDataset1D → Layout1D, and drop SettingsDataset1D.
3. PyAutoHeart/skills/audit_docs/SKILL.md: add a PyAutoCTI row and change the "all three repos" default to four.
4. Verify: the audit script reports 0 dead, and sphinx-build -b html docs shows no new warnings on api/.

Key Files

• PyAutoCTI/docs/api/plot.rst, PyAutoCTI/docs/api/data.rst
• PyAutoCTI/autocti/plot/__init__.py: the source of truth for plot exports
• PyAutoFit/docs/api/plot.rst: the reference pattern
• PyAutoHeart/skills/audit_docs/SKILL.md

Rewrite PyAutoCTI docs/api — 55 of 89 autosummary entries are dead

Type: docs
Target: PyAutoCTI
Repos:

• PyAutoCTI
  Themes:
• docs-hub
• cti
  Difficulty: medium
  Autonomy: supervised
  Priority: normal
  Status: formalised
  Consequence: glance
  Witness: Every autosummary entry under PyAutoCTI/docs/api/ imports and hasattr-resolves against the installed autocti (the /audit_docs sweep reports 0 dead, was 55 of 89), plot.rst documents the function-style autocti.plot exports, the data.rst re-export-or-remove call is recorded, and PyAutoHeart/skills/audit_docs/SKILL.md lists PyAutoCTI.
  Review-minutes: 3
  Unattended: ready
  Epic: cti-upkeep
  Phase: 5
  Filed: 2026-08-06 (backfilled from git)

Filed 2026-08-06 from a full /audit_docs sweep (every autosummary entry
verified by import + hasattr against installed source). PyAutoCTI's
docs/api/ is RTD-published but untouched since 2024-09-27; 62% of its
documented symbols don't exist.

• docs/api/plot.rst (49 dead entries) — the file is an unadapted copy of
  the Lens/Galaxy class-heavy plot-doc template; none of the documented class
  hierarchy (Array2DPlotter…FitImagingCIPlotter, MatPlot1D/2D,
  Include*, Visuals*, 22 matplotlib-wrapper classes, and the
  NestPlotter/MCMCPlotter/MLEPlotter trio removed from autofit in the
  class→function refactor bc917452e) ever existed in CTI
  (git log -S "class MatPlot2D" returns nothing). Rewrite from scratch
  against the actual autocti/plot/__init__.py exports (function-based
  plot_array, plot_yx, subplot_*, figure_* + classes
  PlotterDataset1D, PlotterImagingCI), following the corrected
  function-style pattern planned for PyAutoFit's plot.rst
  (existing draft docs/libraries/pyautofit_plot_rst_dead_plotters.md —
  re-confirmed by this audit; ship that one first as the reference).
• docs/api/data.rst (5 dead) — Grid2D, Grid2DIrregular, Grid1D
  (exist in autoarray but never re-exported by autocti/__init__.py) and
  LayoutDataset1D/SettingsDataset1D (don't exist anywhere; Layout1D
  does). Maintainer call: remove the entries or add the re-exports first.
• docs/api/modeling.rst (2 dead) — PySwarmsLocal/PySwarmsGlobal,
  removed from autofit in cc9fd6df4; drop them.
• arctic.rst, clocking.rst, fitting.rst are clean; Fit/Galaxy/Lens api
  docs are otherwise fully green (447 symbols verified).
• Process gap: PyAutoHeart/skills/audit_docs/SKILL.md's repo table omits
  PyAutoCTI even though it has published docs/api/ — add it so future audits
  don't silently skip the one repo that drifts.