summaryrefslogtreecommitdiff
path: root/doc/sphinxext/docscrape_sphinx.py
diff options
context:
space:
mode:
authorPauli Virtanen <pav@iki.fi>2009-02-06 00:27:08 +0000
committerPauli Virtanen <pav@iki.fi>2009-02-06 00:27:08 +0000
commitd46fa57c68b1f6ff4e9f2da6bf9c1e60045c89cf (patch)
tree96f98c7e3765dad5a08f102b0581aca1d2e5fcc3 /doc/sphinxext/docscrape_sphinx.py
parentaeb090d5f7081a166357fa850950da89feb25e97 (diff)
downloadnumpy-d46fa57c68b1f6ff4e9f2da6bf9c1e60045c89cf.tar.gz
doc/numpydoc: work better together with Sphinx's config option
Diffstat (limited to 'doc/sphinxext/docscrape_sphinx.py')
-rw-r--r--doc/sphinxext/docscrape_sphinx.py11
1 files changed, 7 insertions, 4 deletions
diff --git a/doc/sphinxext/docscrape_sphinx.py b/doc/sphinxext/docscrape_sphinx.py
index d431ecd3f..77ed271b0 100644
--- a/doc/sphinxext/docscrape_sphinx.py
+++ b/doc/sphinxext/docscrape_sphinx.py
@@ -115,7 +115,7 @@ class SphinxFunctionDoc(SphinxDocString, FunctionDoc):
class SphinxClassDoc(SphinxDocString, ClassDoc):
pass
-def get_doc_object(obj, what=None):
+def get_doc_object(obj, what=None, doc=None):
if what is None:
if inspect.isclass(obj):
what = 'class'
@@ -126,8 +126,11 @@ def get_doc_object(obj, what=None):
else:
what = 'object'
if what == 'class':
- return SphinxClassDoc(obj, '', func_doc=SphinxFunctionDoc)
+ return SphinxClassDoc(obj, '', func_doc=SphinxFunctionDoc, doc=doc)
elif what in ('function', 'method'):
- return SphinxFunctionDoc(obj, '')
+ return SphinxFunctionDoc(obj, '', doc=doc)
else:
- return SphinxDocString(pydoc.getdoc(obj))
+ if doc is None:
+ doc = pydoc.getdoc(obj)
+ return SphinxDocString(doc)
+