Skip to content

Commit 1eded92

Browse files
committed
Updated README
1 parent 05f8302 commit 1eded92

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

README.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,12 +45,20 @@ The following options can be set in conf.py:
4545

4646
Whether to show all members of a class in the Methods and Attributes
4747
sections automatically.
48+
``True`` by default.
49+
50+
- numpydoc_show_inherited_class_members: bool
51+
52+
Whether to show all inherited members of a class in the Methods and Attributes
53+
sections automatically. If it's false, inherited members won't shown.
54+
``True`` by default.
4855

4956
- numpydoc_class_members_toctree: bool
5057

5158
Whether to create a Sphinx table of contents for the lists of class
5259
methods and attributes. If a table of contents is made, Sphinx expects
5360
each entry to have a separate page.
61+
``True`` by default.
5462

5563
- numpydoc_edit_link: bool (DEPRECATED -- edit your HTML template instead)
5664

0 commit comments

Comments
 (0)