Add summary template

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

Hide file tree

Showing 3 changed files with 43 additions and 5 deletions.
diff --git a/docs/_config.yml b/docs/_config.yml
@@ -21,4 +21,4 @@ sphinx:
   - 'sphinx.ext.autodoc'
   - 'sphinx.ext.autosummary'
   config:
-    add_module_names: False
+    autosummary_generate: True
diff --git a/docs/_templates/autosummary/class.rst b/docs/_templates/autosummary/class.rst
@@ -0,0 +1,35 @@
+{{ fullname | escape | underline}}
+
+.. currentmodule:: {{ module }}
+
+.. autoclass:: {{ objname }}
+
+   {% block methods %}
+   .. automethod:: __init__
+
+   {% if methods %}
+   .. rubric:: {{ _('Methods') }}
+
+   .. autosummary::
+      :toctree: generated/
+
+   {% for item in methods %}
+       {% if item != "__init__" %}
+          ~{{ name }}.{{ item }}
+       {% endif %}
+   {%- endfor %}
+   {% endif %}
+   {% endblock %}
+
+   {% block attributes %}
+   {% if attributes %}
+   .. rubric:: {{ _('Attributes') }}
+
+   .. autosummary::
+      :toctree: generated/
+
+   {% for item in attributes %}
+      ~{{ name }}.{{ item }}
+   {%- endfor %}
+   {% endif %}
+   {% endblock %}
diff --git a/docs/api.rst b/docs/api.rst
@@ -1,5 +1,8 @@
-API Reference
-=============
+API documentation
+=================
 
-.. automodule:: pympipool
-    :members: generate
+.. autosummary::
+   :toctree: _autosummary
+   :recursive:
+
+   pympipool