Skip to content

Commit

Permalink
DOC: hide audb.config.__eq__() docstring (#476)
Browse files Browse the repository at this point in the history
  • Loading branch information
hagenw authored Dec 4, 2024
1 parent 3d8dc6a commit bd1dcd6
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 0 deletions.
19 changes: 19 additions & 0 deletions docs/_templates/autosummary/class.rst
Original file line number Diff line number Diff line change
@@ -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 %}
1 change: 1 addition & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@
# General -----------------------------------------------------------------
master_doc = "index"
source_suffix = ".rst"
templates_path = ["_templates"]
exclude_patterns = [
"api-src",
"build",
Expand Down

0 comments on commit bd1dcd6

Please sign in to comment.