docs(api): update RST API reference pages for consistency#303
Merged
Conversation
- fitting.rst: add FitEllipse and FitQuantity sections with descriptive headings explaining when each fit class is used - modeling.rst: add AnalysisEllipse and AnalysisQuantity to the Analysis autosummary table - light.rst: add three new sections for linear (ag.lp_linear), operated (ag.lp_operated), and basis (ag.lp_basis) light profiles, each with a brief description explaining the role of that profile family Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
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
1 participant
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
Brings the
docs/api/*.rstSphinx reference pages into consistency with the documentation added across the previous PRs (#292–#302).fitting.rst— AddedFitEllipse(isophote fitting) andFitQuantity(derived-quantity fitting) sections with descriptive headings, bringing it in line with the module docstrings added in thedocs/ellipseanddocs/quantitybranches.modeling.rst— AddedAnalysisEllipseandAnalysisQuantityto the Analysis autosummary table (both classes are exported fromautogalaxyand were already documented but missing from the API reference).light.rst— Added three new sections:Linear [ag.lp_linear]— linear light profiles solved via matrix inversionOperated [ag.lp_operated]— profiles with instrument operation (PSF) already appliedBasis [ag.lp_basis]— MGE / shapelet basis collectionsTest plan
make htmlindocs/)🤖 Generated with Claude Code