Merge pull request #779 from IanCa/develop

Improve toctree in documentation
hed-standard · Oct 23, 2023 · 2b9cf8b · 2b9cf8b
2 parents dc9dfcd + 1406760
commit 2b9cf8b
Show file tree

Hide file tree

Showing 5 changed files with 61 additions and 78 deletions.
diff --git a/docs/source/_templates/autosummary/class.rst b/docs/source/_templates/autosummary/class.rst
diff --git a/docs/source/_templates/custom-class-template.rst b/docs/source/_templates/custom-class-template.rst
@@ -1,32 +1,42 @@
-{{ fullname | escape | underline}}
+{{ fullname.split('.')[-1] | escape | underline }}
 
 .. currentmodule:: {{ module }}
 
-.. autoclass:: {{ objname }}
-   :members:
-   :show-inheritance:
-   :inherited-members:
-
-   {% block methods %}
-   .. automethod:: __init__
-
-   {% if methods %}
-   .. rubric:: {{ _('Methods') }}
-
-   .. autosummary::
-   {% for item in methods %}
-      ~{{ name }}.{{ item }}
-   {%- endfor %}
-   {% endif %}
-   {% endblock %}
-
-   {% block attributes %}
-   {% if attributes %}
-   .. rubric:: {{ _('Attributes') }}
-
-   .. autosummary::
-   {% for item in attributes %}
-      ~{{ name }}.{{ item }}
-   {%- endfor %}
-   {% endif %}
-   {% endblock %}
+.. autoclass:: {{ module }}.{{ objname }}
+   :noindex:
+
+.. rubric:: {{ _('Methods') }}
+
+.. autosummary::
+{% for item in methods %}
+   {{ module }}.{{ objname }}.{{ item }}
+{%- endfor %}
+
+.. rubric:: {{ _('Attributes') }}
+
+.. autosummary::
+{% for item in attributes %}
+   {{ module }}.{{ objname }}.{{ item }}
+{%- endfor %}
+
+.. toctree::
+   :hidden:
+
+{% for item in methods %}
+   {{ fullname }}#method-{{ item }}
+{%- endfor %}
+{% for item in attributes %}
+   {{ fullname }}#attribute-{{ item }}
+{%- endfor %}
+
+{% for item in methods %}
+.. _method-{{ item }}:
+
+.. automethod:: {{ module }}.{{ objname }}.{{ item }}
+{%- endfor %}
+
+{% for item in attributes %}
+.. _attribute-{{ item }}:
+
+.. autoattribute:: {{ module }}.{{ objname }}.{{ item }}
+{%- endfor %}
diff --git a/docs/source/_templates/custom-module-template.rst b/docs/source/_templates/custom-module-template.rst
@@ -1,4 +1,6 @@
-{{ fullname | escape | underline}}
+{{ fullname.split('.')[-1] | escape | underline}}
+
+.. currentmodule:: {{ module }}
 
 .. automodule:: {{ fullname }}
 
@@ -14,17 +16,22 @@
    {% endif %}
    {% endblock %}
 
-   {% block functions %}
-   {% if functions %}
-   .. rubric:: {{ _('Functions') }}
+    {% block functions %}
+    {% if functions %}
+    .. rubric:: {{ _('Functions') }}
 
-   .. autosummary::
-      :toctree:
-   {% for item in functions %}
-      {{ item }}
-   {%- endfor %}
-   {% endif %}
-   {% endblock %}
+    .. autosummary::
+    {% for item in functions %}
+       {{ item }}
+    {% endfor %}
+
+    {% for item in functions %}
+    .. _{{ item }}:
+
+    .. autofunction:: {{ item }}
+    {% endfor %}
+    {% endif %}
+    {% endblock %}
 
    {% block classes %}
    {% if classes %}

diff --git a/docs/source/api2.rst b/docs/source/api2.rst
@@ -1,5 +1,5 @@
-HED API reference (Auto style)
-==============================
+HED API reference
+=================
 
 .. currentmodule:: hed
 

diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -14,14 +14,14 @@ Hierarchical Event Descriptor (HED) Python Tools
 Note:  this is a work in progress. More information is coming.
 
 .. toctree::
-   :maxdepth: 4
+   :maxdepth: 6
    :caption: Contents:
 
    introduction.md
    user_guide.rst
 
 .. toctree::
-   :maxdepth: 4
+   :maxdepth: 6
    :caption: HED Python API:
 
    api2.rst