diff options
Diffstat (limited to 'README.rst')
| -rw-r--r-- | README.rst | 8 |
1 files changed, 8 insertions, 0 deletions
@@ -45,12 +45,20 @@ The following options can be set in conf.py: Whether to show all members of a class in the Methods and Attributes sections automatically. + ``True`` by default. + +- numpydoc_show_inherited_class_members: bool + + Whether to show all inherited members of a class in the Methods and Attributes + sections automatically. If it's false, inherited members won't shown. + ``True`` by default. - numpydoc_class_members_toctree: bool Whether to create a Sphinx table of contents for the lists of class methods and attributes. If a table of contents is made, Sphinx expects each entry to have a separate page. + ``True`` by default. - numpydoc_edit_link: bool (DEPRECATED -- edit your HTML template instead) |