diff options
Diffstat (limited to 'doc/sphinxext/docscrape_sphinx.py')
| -rw-r--r-- | doc/sphinxext/docscrape_sphinx.py | 11 |
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) + |