sphinxext: add numpydoc_show_class_members option (from Michael Droettboom)

1 files changed, 26 insertions, 0 deletions

diff --git a/doc/sphinxext/README.txt b/doc/sphinxext/README.txt
index 96477033b..455a709fb 100644
--- a/doc/sphinxext/README.txt
+++ b/doc/sphinxext/README.txt
@@ -24,3 +24,29 @@ The following extensions are available:
     Available in Sphinx 0.6.2 and (to-be) 1.0 as ``sphinx.ext.autosummary``,
     and it the Sphinx 1.0 version is recommended over that included in
     Numpydoc.
+
+
+numpydoc
+========
+
+Numpydoc inserts a hook into Sphinx's autodoc that converts docstrings
+following the Numpy/Scipy format to a form palatable to Sphinx.
+
+Options
+-------
+
+The following options can be set in conf.py:
+
+- numpydoc_use_plots: bool
+
+  Whether to produce ``plot::`` directives for Examples sections that
+  contain ``import matplotlib``.
+
+- numpydoc_show_class_members: bool
+
+  Whether to show all members of a class in the Methods and Attributes
+  sections automatically.
+
+- numpydoc_edit_link: bool  (DEPRECATED -- edit your HTML template instead)
+
+  Whether to insert an edit link after docstrings.