From 84ee7c1365614373abb59bf939379d42d7155b7e Mon Sep 17 00:00:00 2001 From: William Jamieson Date: Fri, 10 Jan 2025 14:40:06 -0500 Subject: [PATCH] Update documentation with new option --- sphinx_automodapi/automodapi.py | 5 +++++ sphinx_automodapi/automodsumm.py | 5 +++++ 2 files changed, 10 insertions(+) diff --git a/sphinx_automodapi/automodapi.py b/sphinx_automodapi/automodapi.py index eae0803..fdb49d5 100644 --- 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 index 49459d7..268a0a7 100644 --- 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