Add autodoc_default_options to inherit docstrings #830
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.
Closes #828
I set the following defaults for the autodoc. The first interesting thing is that
'inherited-members': True
fixes #828 because it will now show the inherited docstrings. The second thing is that'members': True
significantly cleans up the docs because I can remove it everywhere else.Note that I also removed
:undoc-members:
, because I don't think we should show methods that are not documented (it adds a lot of unreadable sections). But feel free to add it in the defaults if you prefer to have it @LucaMarconato