sphinxext: add numpydoc_show_class_members option (from Michael Droettboom)

1 files changed, 16 insertions, 9 deletions

diff --git a/doc/sphinxext/docscrape_sphinx.py b/doc/sphinxext/docscrape_sphinx.py
index 12907731e..af8486f25 100644
--- a/doc/sphinxext/docscrape_sphinx.py
+++ b/doc/sphinxext/docscrape_sphinx.py
@@ -3,7 +3,9 @@ import sphinx
 from docscrape import NumpyDocString, FunctionDoc, ClassDoc
 
 class SphinxDocString(NumpyDocString):
-    use_plots = False
+    def __init__(self, docstring, config={}):
+        self.use_plots = config.get('use_plots', False)
+        NumpyDocString.__init__(self, docstring, config=config)
 
     # string conversion routines
     def _str_header(self, name, symbol='`'):
@@ -189,17 +191,21 @@ class SphinxDocString(NumpyDocString):
         return '\n'.join(out)
 
 class SphinxFunctionDoc(SphinxDocString, FunctionDoc):
-    pass
+    def __init__(self, obj, doc=None, config={}):
+        self.use_plots = config.get('use_plots', False)
+        FunctionDoc.__init__(self, obj, doc=doc, config=config)
 
 class SphinxClassDoc(SphinxDocString, ClassDoc):
-    pass
+    def __init__(self, obj, doc=None, config={}):
+        self.use_plots = config.get('use_plots', False)
+        ClassDoc.__init__(self, obj, doc=doc, config=config)
 
 class SphinxObjDoc(SphinxDocString):
-    def __init__(self, obj, doc):
+    def __init__(self, obj, doc=None, config={}):
         self._f = obj
-        SphinxDocString.__init__(self, doc)
+        SphinxDocString.__init__(self, doc, config=config)
 
-def get_doc_object(obj, what=None, doc=None):
+def get_doc_object(obj, what=None, doc=None, config={}):
     if what is None:
         if inspect.isclass(obj):
             what = 'class'
@@ -210,10 +216,11 @@ def get_doc_object(obj, what=None, doc=None):
         else:
             what = 'object'
     if what == 'class':
-        return SphinxClassDoc(obj, '', func_doc=SphinxFunctionDoc, doc=doc)
+        return SphinxClassDoc(obj, func_doc=SphinxFunctionDoc, doc=doc,
+                              config=config)
     elif what in ('function', 'method'):
-        return SphinxFunctionDoc(obj, '', doc=doc)
+        return SphinxFunctionDoc(obj, doc=doc, config=config)
     else:
         if doc is None:
             doc = pydoc.getdoc(obj)
-        return SphinxObjDoc(obj, doc)
+        return SphinxObjDoc(obj, doc, config=config)