Skip to content

Commit daa669d

Browse files
committed
Document numpydoc_class_members_toctree option
1 parent 5f7b225 commit daa669d

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

README.txt

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,12 @@ The following options can be set in conf.py:
4040
Whether to show all members of a class in the Methods and Attributes
4141
sections automatically.
4242

43+
- numpydoc_class_members_toctree: bool
44+
45+
Whether to create a Sphinx table of contents for the lists of class
46+
methods and attributes. If a table of contents is made, Sphinx expects
47+
each entry to have a separate page.
48+
4349
- numpydoc_edit_link: bool (DEPRECATED -- edit your HTML template instead)
4450

4551
Whether to insert an edit link after docstrings.

0 commit comments

Comments
 (0)