diff options
author | Pauli Virtanen <pav@iki.fi> | 2009-11-13 18:42:21 +0000 |
---|---|---|
committer | Pauli Virtanen <pav@iki.fi> | 2009-11-13 18:42:21 +0000 |
commit | 9d48a39d23b507e18ca8fa7c5786b5eaea926d0e (patch) | |
tree | 1cba79256dcf51273ad43a88dd8a8393e32e5728 /doc/sphinxext/traitsdoc.py | |
parent | 66313a336889e2ff898dad34ffae32d928bb2d5b (diff) | |
download | numpy-9d48a39d23b507e18ca8fa7c5786b5eaea926d0e.tar.gz |
sphinxext: add numpydoc_show_class_members option (from Michael Droettboom)
Diffstat (limited to 'doc/sphinxext/traitsdoc.py')
-rw-r--r-- | doc/sphinxext/traitsdoc.py | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/doc/sphinxext/traitsdoc.py b/doc/sphinxext/traitsdoc.py index 6bfd14906..0fcf2c1cd 100644 --- a/doc/sphinxext/traitsdoc.py +++ b/doc/sphinxext/traitsdoc.py @@ -111,7 +111,7 @@ def looks_like_issubclass(obj, classname): return True return False -def get_doc_object(obj, what=None): +def get_doc_object(obj, what=None, config=None): if what is None: if inspect.isclass(obj): what = 'class' @@ -122,7 +122,7 @@ def get_doc_object(obj, what=None): else: what = 'object' if what == 'class': - doc = SphinxTraitsDoc(obj, '', func_doc=SphinxFunctionDoc) + doc = SphinxTraitsDoc(obj, '', func_doc=SphinxFunctionDoc, config=config) if looks_like_issubclass(obj, 'HasTraits'): for name, trait, comment in comment_eater.get_class_traits(obj): # Exclude private traits. @@ -130,9 +130,9 @@ def get_doc_object(obj, what=None): doc['Traits'].append((name, trait, comment.splitlines())) return doc elif what in ('function', 'method'): - return SphinxFunctionDoc(obj, '') + return SphinxFunctionDoc(obj, '', config=config) else: - return SphinxDocString(pydoc.getdoc(obj)) + return SphinxDocString(pydoc.getdoc(obj), config=config) def setup(app): # init numpydoc |