Add :include: option, to do the opposite of :skip:#127
Merged
saimn merged 2 commits intoastropy:mainfrom May 1, 2021
Merged
Conversation
Contributor
|
Sounds good, but would be great to have some tests (similar to the ones with |
This was referenced Dec 27, 2021
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This is a potential solution for #92: This adds an
:include:option toautomodapi, if a user only wants to, e.g., pick a few object names to generate documentation for withautomodapi.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 toautomodsumm. But hey, it seems to work 🤷♂️