File tree 2 files changed +10
-0
lines changed
2 files changed +10
-0
lines changed Original file line number Diff line number Diff line change @@ -104,6 +104,11 @@ class are included in the generated documentation. Defaults to ``False``.
104
104
methods like ``__getitem__`` and ``__setitem__``. Defaults to
105
105
``['__init__', '__call__']``.
106
106
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
+
107
112
.. _automodule: http://sphinx-doc.org/latest/ext/autodoc.html?highlight=automodule#directive-automodule
108
113
"""
109
114
Original file line number Diff line number Diff line change @@ -74,6 +74,11 @@ class members that are inherited from a base class. This value can be
74
74
methods like ``__getitem__`` and ``__setitem__``. Defaults to
75
75
``['__init__', '__call__']``.
76
76
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
+
77
82
.. _sphinx.ext.autosummary: http://sphinx-doc.org/latest/ext/autosummary.html
78
83
.. _autosummary: http://sphinx-doc.org/latest/ext/autosummary.html#directive-autosummary
79
84
You can’t perform that action at this time.
0 commit comments