diff options
author | Joris Van den Bossche <jorisvandenbossche@gmail.com> | 2018-03-30 09:39:08 +0200 |
---|---|---|
committer | Joris Van den Bossche <jorisvandenbossche@gmail.com> | 2018-03-30 09:47:19 +0200 |
commit | 5c2f4fee21108bbca3c44ceae340e2f8bdd64ec5 (patch) | |
tree | ff52bc22b6f964c3f906491ab6e7a494ce3861f6 | |
parent | fb6afac29df192b59bafadf505c296ec63e32dea (diff) | |
download | numpydoc-5c2f4fee21108bbca3c44ceae340e2f8bdd64ec5.tar.gz |
Add option to use member listing for attributes
-rw-r--r-- | numpydoc/docscrape_sphinx.py | 7 | ||||
-rw-r--r-- | numpydoc/numpydoc.py | 5 |
2 files changed, 9 insertions, 3 deletions
diff --git a/numpydoc/docscrape_sphinx.py b/numpydoc/docscrape_sphinx.py index 087ddaf..1da99ed 100644 --- a/numpydoc/docscrape_sphinx.py +++ b/numpydoc/docscrape_sphinx.py @@ -33,6 +33,7 @@ class SphinxDocString(NumpyDocString): self.use_plots = config.get('use_plots', False) self.use_blockquotes = config.get('use_blockquotes', False) self.class_members_toctree = config.get('class_members_toctree', True) + self.attributes_as_param_list = config.get('attributes_as_param_list', True) self.template = config.get('template', None) if self.template is None: template_dirs = [os.path.join(os.path.dirname(__file__), 'templates')] @@ -366,8 +367,10 @@ class SphinxDocString(NumpyDocString): 'notes': self._str_section('Notes'), 'references': self._str_references(), 'examples': self._str_examples(), - 'attributes': self._str_param_list('Attributes', - fake_autosummary=True), + 'attributes': + self._str_param_list('Attributes', fake_autosummary=True) + if self.attributes_as_param_list + else self._str_member_list('Attributes'), 'methods': self._str_member_list('Methods'), } ns = dict((k, '\n'.join(v)) for k, v in ns.items()) diff --git a/numpydoc/numpydoc.py b/numpydoc/numpydoc.py index 2b259af..e4327fa 100644 --- a/numpydoc/numpydoc.py +++ b/numpydoc/numpydoc.py @@ -115,7 +115,9 @@ def mangle_docstrings(app, what, name, obj, options, lines): 'show_class_members': app.config.numpydoc_show_class_members, 'show_inherited_class_members': app.config.numpydoc_show_inherited_class_members, - 'class_members_toctree': app.config.numpydoc_class_members_toctree} + 'class_members_toctree': app.config.numpydoc_class_members_toctree, + 'attributes_as_param_list': + app.config.numpydoc_attributes_as_param_list} u_NL = sixu('\n') if what == 'module': @@ -186,6 +188,7 @@ def setup(app, get_doc_object_=get_doc_object): app.add_config_value('numpydoc_show_inherited_class_members', True, True) app.add_config_value('numpydoc_class_members_toctree', True, True) app.add_config_value('numpydoc_citation_re', '[a-z0-9_.-]+', True) + app.add_config_value('numpydoc_attributes_as_param_list', True, True) # Extra mangling domains app.add_domain(NumpyPythonDomain) |