Skip to content

Commit 84ee7c1

Browse files
Update documentation with new option
1 parent 80641ef commit 84ee7c1

File tree

2 files changed

+10
-0
lines changed

2 files changed

+10
-0
lines changed

Diff for: sphinx_automodapi/automodapi.py

+5
Original file line numberDiff line numberDiff line change
@@ -104,6 +104,11 @@ class are included in the generated documentation. Defaults to ``False``.
104104
methods like ``__getitem__`` and ``__setitem__``. Defaults to
105105
``['__init__', '__call__']``.
106106
107+
* ``automodsumm_properties_are_attributes``
108+
Should be a bool and if ``True`` properties are treated as attributes in the
109+
documentation meaning that no property specific documentation is generated.
110+
Defaults to ``True``.
111+
107112
.. _automodule: http://sphinx-doc.org/latest/ext/autodoc.html?highlight=automodule#directive-automodule
108113
"""
109114

Diff for: sphinx_automodapi/automodsumm.py

+5
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,11 @@ class members that are inherited from a base class. This value can be
7474
methods like ``__getitem__`` and ``__setitem__``. Defaults to
7575
``['__init__', '__call__']``.
7676
77+
* ``automodsumm_properties_are_attributes``
78+
Should be a bool and if ``True`` properties are treated as attributes in the
79+
documentation meaning that no property specific documentation is generated.
80+
Defaults to ``True``.
81+
7782
.. _sphinx.ext.autosummary: http://sphinx-doc.org/latest/ext/autosummary.html
7883
.. _autosummary: http://sphinx-doc.org/latest/ext/autosummary.html#directive-autosummary
7984

0 commit comments

Comments
 (0)