summaryrefslogtreecommitdiff
path: root/README.rst
diff options
context:
space:
mode:
authorespdev <esp.home@gmail.com>2014-05-10 12:47:53 +0400
committerespdev <esp.home@gmail.com>2014-05-10 12:47:53 +0400
commit1eded928a33b2f43303cf9dcf1a7217b82ba8069 (patch)
tree6a7a4ccf9e020ef4043efbdf89df959614394d58 /README.rst
parent05f8302cc4672f337cbadbad6b5d7705b61994f7 (diff)
downloadnumpydoc-1eded928a33b2f43303cf9dcf1a7217b82ba8069.tar.gz
Updated README
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst8
1 files changed, 8 insertions, 0 deletions
diff --git a/README.rst b/README.rst
index e2711e1..7c93abc 100644
--- a/README.rst
+++ b/README.rst
@@ -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)