From bd1dcd64dbf21ce8d76d31f2464e14a591295e0b Mon Sep 17 00:00:00 2001 From: Hagen Wierstorf Date: Wed, 4 Dec 2024 10:45:37 +0100 Subject: [PATCH] DOC: hide audb.config.__eq__() docstring (#476) --- docs/_templates/autosummary/class.rst | 19 +++++++++++++++++++ docs/conf.py | 1 + 2 files changed, 20 insertions(+) create mode 100644 docs/_templates/autosummary/class.rst diff --git a/docs/_templates/autosummary/class.rst b/docs/_templates/autosummary/class.rst new file mode 100644 index 00000000..fab14c3d --- /dev/null +++ b/docs/_templates/autosummary/class.rst @@ -0,0 +1,19 @@ +{{ objname | escape | underline}} + +.. currentmodule:: {{ module }} + +.. autoclass:: {{ objname }} + +{% block methods %} +{%- for item in (all_methods + attributes)|sort %} + {%- if not item.startswith('_') or item in hidden_methods %} + {%- if item in all_methods and objname != 'config' %} +{{ (item + '()') | escape | underline(line='-') }} +.. automethod:: {{ name }}.{{ item }} + {%- elif item in attributes %} +{{ item | escape | underline(line='-') }} +.. autoattribute:: {{ name }}.{{ item }} + {%- endif %} + {% endif %} +{%- endfor %} +{% endblock %} diff --git a/docs/conf.py b/docs/conf.py index 9f1a1db2..ae343c72 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -21,6 +21,7 @@ # General ----------------------------------------------------------------- master_doc = "index" source_suffix = ".rst" +templates_path = ["_templates"] exclude_patterns = [ "api-src", "build",