search

astropy / sphinx-automodapi

Sphinx extension for generating API documentation
https://sphinx-automodapi.readthedocs.io
BSD 3-Clause "New" or "Revised" License
65 stars 45 forks source link

Add :include: option, to do the opposite of :skip: #127

Closed adrn closed 3 years ago

adrn commented 3 years ago

This is a potential solution for #92: This adds an :include: option to automodapi, if a user only wants to, e.g., pick a few object names to generate documentation for with automodapi.

This is kind of a hack, because this implementation takes any object found that does not appear in :include: and adds them to the list of object names to skip before passing on to automodsumm. But hey, it seems to work 🤷‍♂️

saimn commented 3 years ago

Sounds good, but would be great to have some tests (similar to the ones with :skip:).