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

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

Merged
merged 2 commits into from May 1, 2021
Merged

Conversation

adrn
Copy link
Member

@adrn adrn commented Apr 26, 2021

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 🤷‍♂️

@pllim pllim requested a review from astrofrog April 26, 2021 14:05
@pllim pllim requested a review from saimn April 26, 2021 14:06
@saimn
Copy link
Contributor

saimn commented Apr 30, 2021

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

Copy link
Contributor

@saimn saimn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! 👍

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

Successfully merging this pull request may close these issues.

None yet

3 participants