-
Notifications
You must be signed in to change notification settings - Fork 87
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
Closes #1987 - Updates AutoAPI Documentation #2148
Closes #1987 - Updates AutoAPI Documentation #2148
Conversation
…g documented on GitHub pages.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Style changes look good
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good to me! Well done running on this down!
I saw a couple of small things but I imagine we're gonna find a lot of them over the next few months
Closes #1987
__all__
to ensure they are documented. Files where everything is client facing do not require__all__
._
. This does not include all that exist, but this will be an ongoing process.pydoc/conf.py
to setautoapi_options
to['members', 'undoc-members', 'show-inheritance', 'show-module-summary', 'imported-members', ]
as opposed to using the default. This removesprivate-members
andspecial-members
. This prevents private functions (_func_name
) from being included in the AutoAPI docs. It also prevents functions like__len__()
from being rendered in the AutoAPI.This PR does not address missing DocStrings. A separate issue will be put in to update missing DocStrings.