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

Is it possible to specify classes for automodapi #92

Closed appukuttan-shailesh closed 3 years ago

appukuttan-shailesh commented 4 years ago

I like the use of automodapi, but was curious if there is a way to specify the classes that should be displayed. Basically the opposite of :skip: str (which allows us to remove unnecessary entries).

Is there any option to specify what we want included? I see that this is possible via autosummary (it's default behavior), but given a choice, I would like to use automodapi because of other benefits.

As a hack currently I am having to create a large exclusion list to supply to :skip:. But this isn't neat, as I often need to document only 5-6 classes, while having to exclude a much larger number of entries.

adrn commented 3 years ago

See #127, now merged into main!

adrn commented 3 years ago

(ps: @saimn this can be closed)

appukuttan-shailesh commented 3 years ago

Thanks @adrn for implementing this!