Skip to content

docs: prune stale API-doc references #492

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
Jul 9, 2026
Merged

docs: prune stale API-doc references #492

Show file tree
Hide file tree
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
3 changes: 0 additions & 3 deletions docs/api/data.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,10 +32,8 @@ For datasets taken with a CCD (or similar imaging device), including objects whi
:recursive:

Imaging
SettingsImaging
SimulatorImaging
Convolver
Convolver

Interferometer
--------------
Expand All @@ -47,7 +45,6 @@ a fast Fourier transform to map data to the uv-plane.
:toctree: _autosummary

Interferometer
SettingsInterferometer
SimulatorInterferometer
Visibilities
TransformerDFT
Expand Down
5 changes: 1 addition & 4 deletions docs/api/modeling.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,8 +40,6 @@ Markov Chain Monte Carlo (MCMC) and Maximum Likelihood Estimaotrs (MLE).
BFGS
DynestyDynamic
Emcee
PySwarmsLocal
PySwarmsGlobal

Priors
------
Expand All @@ -66,5 +64,4 @@ Adapt
.. autosummary::
:toctree: generated/

AdaptImages
AdaptImageMaker
AdaptImages
80 changes: 0 additions & 80 deletions docs/api/plot.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,83 +78,3 @@ Module-level functions for visualizing non-linear search results.
corner_anesthetic
subplot_parameters
log_likelihood_vs_iteration

Plot Customization [aplt]
-------------------------

Customize figures created via ``Plotter`` objects, including changing ``matplotlib`` settings and adding
visuals to figures.

.. currentmodule:: autogalaxy.plot

.. autosummary::
:toctree: _autosummary
:template: custom-class-template.rst
:recursive:

MatPlot1D
MatPlot2D
Visuals1D
Visuals2D

Matplot Lib Wrappers [aplt]
---------------------------

Wrappers for every ``matplotlib`` function used by a ``Plotter``, allowing for detailed customization of
every figure and subplot.

.. currentmodule:: autogalaxy.plot

**Matplotlib Wrapper Base Objects:**

.. autosummary::
:toctree: _autosummary
:template: custom-class-template.rst
:recursive:

Units
Figure
Axis
Cmap
Colorbar
ColorbarTickParams
TickParams
YTicks
XTicks
Title
YLabel
XLabel
Legend
Output

**Matplotlib Wrapper 1D Objects:**

.. autosummary::
:toctree: _autosummary
:template: custom-class-template.rst
:recursive:

YXPlot

**Matplotlib Wrapper 2D Objects:**

.. autosummary::
:toctree: _autosummary
:template: custom-class-template.rst
:recursive:

ArrayOverlay
GridScatter
GridPlot
VectorYXQuiver
PatchOverlay
VoronoiDrawer
OriginScatter
MaskScatter
BorderScatter
PositionsScatter
IndexScatter
MeshGridScatter
ParallelOverscanPlot
SerialPrescanPlot
SerialOverscanPlot
Loading