Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Is it possible to specify classes for automodapi #92

Closed
appukuttan-shailesh opened this issue Dec 19, 2019 · 3 comments
Closed

Is it possible to specify classes for automodapi #92

appukuttan-shailesh opened this issue Dec 19, 2019 · 3 comments

Comments

@appukuttan-shailesh
Copy link

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
Copy link
Member

adrn commented May 1, 2021

See #127, now merged into main!

@adrn
Copy link
Member

adrn commented May 1, 2021

(ps: @saimn this can be closed)

@saimn saimn closed this as completed May 1, 2021
@appukuttan-shailesh
Copy link
Author

Thanks @adrn for implementing this!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants