Repository navigation
docs: rewrite docs/api plot.rst for the functional API; drop dead data.rst entries - #124
Merged
Merged
Conversation
…d data.rst entries plot.rst was an unadapted copy of the Lens/Galaxy class-based template: 48 of its entries (Plotter/MatPlot/Include/Visuals classes) never existed in autocti. It now documents the real autocti.plot exports in the functional style of PyAutoFit's plot.rst. data.rst: Grid2D/Grid2DIrregular/Grid1D removed (not used or re-exported by autocti), LayoutDataset1D -> Layout1D, SettingsDataset1D dropped (does not exist). Audit: 84 entries / 53 dead -> 64 / 0. sphinx-build: 159 warnings (53 on api/) -> 53 (0 on api/). Closes #123 Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2 tasks done
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
PyAutoCTI's published
docs/api/had 53 of 84 autosummary entries pointing to symbols that don't exist.plot.rstwas an unadapted copy of the Lens/Galaxy class-based plot template (48 Plotter/MatPlot/Include/Visuals classes CTI never had). It is rewritten for the real functionalautocti.plotAPI, in the style of PyAutoFit'splot.rst.data.rstloses 5 entries thatautoctinever exports. Closes #123 (cti-upkeep phase 5c).API Changes
None. Documentation only, no code changes.
Test Plan
hasattraudit of every autosummary entry: 84 entries / 53 dead → 64 / 0sphinx-build -b html docs(docs/requirements.txt + PyAuto313): main 159 warnings (53 onapi/) → branch 53 warnings (0 onapi/); the 53 left are pre-existing and outsideapi/autocti.plot.subplot_fit_ci,PlotterImagingCIand the other function and class pages rendertest_autocti: 279 passed (serial)Full API Changes (for automation & release notes)
Docs pages
docs/api/plot.rst: rewritten. Sections: Dataset 1D (dataset and fit), Charge Injection Imaging (dataset and fit), General Plot Functions, Non-linear Search Plots (re-exported from autofit), Figure Output, Visualization During a Fit (PlotterDataset1D,PlotterImagingCI). Every entry is anautocti.plotexport.docs/api/data.rst: removedGrid2D,Grid2DIrregularandGrid1D(not used or re-exported byautocti; documented by autoarray) and the grid wording;LayoutDataset1D→Layout1D; removedSettingsDataset1D(doesn't exist).No code symbols changed.
Related: PyAutoHeart PR (adds PyAutoCTI to
/audit_docs) on branchfeature/cti-api-rst-rewrite.Separately noticed, not changed here:
docs/requirements.txtpinsautonerves==2024.11.6.1, andconf.pyclones PyAutoFit/PyAutoArray from the oldrhayes777/Jammy2211URLs. Both are RTD-build concerns that belong with the phase 3cdocs.ymlwork.Tier: glance. Merge mode: auto-merge on green if the Witness passes. Heart was STALE at ship time ("release validation stale: source moved since rehearsal (PyAutoNerves)"); the human acknowledged it.
🤖 Generated with Claude Code