docs(api): list SersicMultipole and GaussianMultipole in autosummary#515
Merged
Conversation
…e autosummary PyAutoLens re-exports autogalaxy.profiles.light.standard as lp, so the two new classes added in PyAutoGalaxy#420 (SersicMultipole, GaussianMultipole) are accessible as al.lp.SersicMultipole and al.lp.GaussianMultipole. This adds the matching autosummary entries to the lens docs. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
3 tasks
nataliehogg
pushed a commit
to nataliehogg/PyAutoLens
that referenced
this pull request
Jun 3, 2026
Add the previously missing Linear, Operated, and Basis autosummary sections to docs/api/light.rst and add the one-line description to the Standard section. After this change the file is byte-identical to PyAutoGalaxy/docs/api/light.rst. The SersicMultipole and GaussianMultipole profiles merged via PyAutoLabs#515 (and their PyAutoGalaxy linear variants) are exposed on al.lp_linear.* but previously had no entry on the PyAutoLens API reference page. This brings the docs in line. 🤖 Generated with [Claude Code](https://claude.com/claude-code)
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
Docs-only follow-up to PyAutoLabs/PyAutoGalaxy#420 (which adds
SersicMultipoleandGaussianMultipoletoautogalaxy.profiles.light.standard).Since PyAutoLens re-exports that module as
lp, the two new classes are accessible asal.lp.SersicMultipoleandal.lp.GaussianMultipolewithout any code change here. This PR registers them in the Sphinx autosummary table under the Standard [ag.lp] section so they appear in the rendered lens docs alongsideSersic,Gaussian, etc.API Changes
None — pure documentation entries.
Test Plan
docs/api/light.rstlistsSersicMultipoleandGaussianMultipolein the Standard sectional.lp.SersicMultipoleandal.lp.GaussianMultipoleresolve through the existing re-export atautolens/__init__.py:78Coordination
Merge after PyAutoLabs/PyAutoGalaxy#420 — the autosummary entries depend on the classes existing in the autogalaxy install picked up by ReadTheDocs.
🤖 Generated with Claude Code