Update documentation with new option

astropy · Jan 10, 2025 · 84ee7c1 · 84ee7c1
1 parent 80641ef
commit 84ee7c1
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 0 deletions.
diff --git a/sphinx_automodapi/automodapi.py b/sphinx_automodapi/automodapi.py
@@ -104,6 +104,11 @@ class are included in the generated documentation. Defaults to ``False``.
     methods like ``__getitem__`` and ``__setitem__``. Defaults to
     ``['__init__', '__call__']``.
 
+* ``automodsumm_properties_are_attributes``
+    Should be a bool and if ``True`` properties are treated as attributes in the
+    documentation meaning that no property specific documentation is generated.
+    Defaults to ``True``.
+
 .. _automodule: http://sphinx-doc.org/latest/ext/autodoc.html?highlight=automodule#directive-automodule
 """
 

diff --git a/sphinx_automodapi/automodsumm.py b/sphinx_automodapi/automodsumm.py
@@ -74,6 +74,11 @@ class members that are inherited from a base class. This value can be
     methods like ``__getitem__`` and ``__setitem__``. Defaults to
     ``['__init__', '__call__']``.
 
+* ``automodsumm_properties_are_attributes``
+    Should be a bool and if ``True`` properties are treated as attributes in the
+    documentation meaning that no property specific documentation is generated.
+    Defaults to ``True``.
+
 .. _sphinx.ext.autosummary: http://sphinx-doc.org/latest/ext/autosummary.html
 .. _autosummary: http://sphinx-doc.org/latest/ext/autosummary.html#directive-autosummary