Added a config option for showing/hiding the inherited class members #22
Conversation
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
…ption enables showing of inherited class members in the docs. The option has enabled by default.
espdev
changed the title
pv
added a commit
that referenced
this pull request
Sep 7, 2014
ENH: Add a config option for showing/hiding the inherited class members
|
Thanks, looks good to me. |
|
Thank you very much for merging! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
I use Sphinx and numpydoc extension for creating my projects documentation. In my projects I use PyQt (for example). My classes are often inherited from Qt classes. Qt classes have a lot of members and I do not want to see them in my documentation if I do not overload them.
I have added a config bool option
numpydoc_show_inherited_class_members. This option allows showing/hiding inherited (not overloaded) members from doc. It's true by default (show all members). The option would work only, if the optionnumpydoc_show_class_memberswas enabled.