astropy / astropy/sphinx-automodapi
No-inherited-members option ignored in a find_mod_objs call
- Dominant language
- Python
- Stars
- 67
- Forks
- 48
- Avg merge
- 11h 52m
- Merged PRs (30d)
- 1
Description
In file `sphinx_automodapi/automodsumm.py`, there is a call to `find_mod_objs` that ignores the `no-inherited-members` flag. I don't know if this is correct or not, but in my use case, it does cause autodoc to process unwanted members when the flag is set.
https://github.com/astropy/sphinx-automodapi/blob/a856c2948129929aba83c4b26aee0a31ca530de2/sphinx_automodapi/automodsumm.py#L135
Contributor guide
No contributing guide indexed for this repository
Research direction
Start in sphinx_automodapi/automodsumm.py at the find_mod_objs call around line 135. Trace how the no-inherited-members flag reaches this call and compare the resulting autodoc behavior when the flag is set. Done means the option is honored so unwanted inherited members are not processed.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 35/100