astropy / astropy/sphinx-automodapi
Add ability to ignore certain classes in the hierarchy
- Dominant language
- Python
- Stars
- 67
- Forks
- 48
- Avg merge
- 11h 52m
- Merged PRs (30d)
- 1
Description
Let's consider the following class hierarchy: ``SpectralAxis(SpectralCoord(SpectralQuantity(Quantity(ndarray))))`` - it would be nice to have a way to document ``SpectralAxis``, including all the methods on ``SpectralCoord`` and ``SpectralQuantity``, but ignoring ``Quantity`` and ``ndarray``.
Contributor guide
No contributing guide indexed for this repository
Research direction
The issue names no files, tests, or entry points, so first locate the hierarchy-documentation code and trace how inherited members are collected for SpectralAxis. Check how SpectralCoord, SpectralQuantity, Quantity, and ndarray are handled, then add coverage showing that selected ancestors can be ignored while intermediate classes remain documented.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100