Try recommended template

pyiron · May 4, 2024 · 25b7591 · 25b7591
1 parent 66f7cd1
commit 25b7591
Show file tree

Hide file tree

Showing 3 changed files with 71 additions and 7 deletions.
diff --git a/docs/api.rst b/docs/api.rst
@@ -3,6 +3,7 @@ API documentation
 
 .. autosummary::
    :toctree: _autosummary
+   :template: templates/custom-module-template.rst
    :recursive:
 
    pympipool
diff --git a/docs/_templates/autosummary/class.rst → docs/templates/custom-class-template.rst b/docs/_templates/autosummary/class.rst → docs/templates/custom-class-template.rst
@@ -3,6 +3,9 @@
 .. currentmodule:: {{ module }}
 
 .. autoclass:: {{ objname }}
+   :members:
+   :show-inheritance:
+   :inherited-members:
 
    {% block methods %}
    .. automethod:: __init__
@@ -11,12 +14,8 @@
    .. rubric:: {{ _('Methods') }}
 
    .. autosummary::
-      :toctree: generated/
-
    {% for item in methods %}
-       {% if item != "__init__" %}
-          ~{{ name }}.{{ item }}
-       {% endif %}
+      ~{{ name }}.{{ item }}
    {%- endfor %}
    {% endif %}
    {% endblock %}
@@ -26,8 +25,6 @@
    .. rubric:: {{ _('Attributes') }}
 
    .. autosummary::
-      :toctree: generated/
-
    {% for item in attributes %}
       ~{{ name }}.{{ item }}
    {%- endfor %}

diff --git a/docs/templates/custom-module-template.rst b/docs/templates/custom-module-template.rst
@@ -0,0 +1,66 @@
+{{ fullname | escape | underline}}
+
+.. automodule:: {{ fullname }}
+
+   {% block attributes %}
+   {% if attributes %}
+   .. rubric:: Module Attributes
+
+   .. autosummary::
+      :toctree:
+   {% for item in attributes %}
+      {{ item }}
+   {%- endfor %}
+   {% endif %}
+   {% endblock %}
+
+   {% block functions %}
+   {% if functions %}
+   .. rubric:: {{ _('Functions') }}
+
+   .. autosummary::
+      :toctree:
+   {% for item in functions %}
+      {{ item }}
+   {%- endfor %}
+   {% endif %}
+   {% endblock %}
+
+   {% block classes %}
+   {% if classes %}
+   .. rubric:: {{ _('Classes') }}
+
+   .. autosummary::
+      :toctree:
+      :template: custom-class-template.rst
+   {% for item in classes %}
+      {{ item }}
+   {%- endfor %}
+   {% endif %}
+   {% endblock %}
+
+   {% block exceptions %}
+   {% if exceptions %}
+   .. rubric:: {{ _('Exceptions') }}
+
+   .. autosummary::
+      :toctree:
+   {% for item in exceptions %}
+      {{ item }}
+   {%- endfor %}
+   {% endif %}
+   {% endblock %}
+
+{% block modules %}
+{% if modules %}
+.. rubric:: Modules
+
+.. autosummary::
+   :toctree:
+   :template: custom-module-template.rst
+   :recursive:
+{% for item in modules %}
+   {{ item }}
+{%- endfor %}
+{% endif %}
+{% endblock %}