docs(api): update RST API reference pages for consistency#400
Merged
Conversation
- fitting.rst: add FitQuantity section with description; split into Imaging/Interferometer and Quantity subsections - point.rst: restructure into Dataset / Solver / Fitting / Position Likelihood / Analysis sections; add FitPointDataset, FitPositionsImagePairAll, FitPositionsImagePairRepeat, FitPositionsSource, FitTimeDelays, PositionsLH - modeling.rst: add AnalysisQuantity to Analysis autosummary table - galaxy.rst: add descriptive text for Galaxy/Galaxies/Tracer section 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 module-leveldocumentation added in PRs #393–#399.
fitting.rst— AddedFitQuantitysection; split intoImaging and Interferometerand
Quantitysubsections, each with a descriptive sentence explaining the use case.point.rst— Restructured into five named sections (Dataset / Solver / Fitting /Position Likelihood / Analysis); added six missing entries:
FitPointDataset,FitPositionsImagePairAll,FitPositionsImagePairRepeat,FitPositionsSource,FitTimeDelays,PositionsLH.modeling.rst— AddedAnalysisQuantityto the Analysis autosummary table(was exported from
autolensbut absent from the API reference).galaxy.rst— Added a short descriptive paragraph explainingGalaxy/Galaxies/
Tracerand their roles.Test plan
make htmlindocs/)🤖 Generated with Claude Code