Restore templates; for real this time

Signed-off-by: Shah, Karan <[email protected]>
securefederatedai · Dec 18, 2024 · 9d9cb14 · 9d9cb14
1 parent 9b5e457
commit 9d9cb14
Show file tree

Hide file tree

Showing 15 changed files with 113 additions and 7 deletions.
diff --git a/docs/_templates/custom-class-template.rst b/docs/_templates/custom-class-template.rst
@@ -0,0 +1,34 @@
+{{ fullname | escape | underline}}
+
+.. currentmodule:: {{ module }}
+
+.. autoclass:: {{ objname }}
+   :members:
+   :show-inheritance:
+   :inherited-members:
+   :special-members: __call__, __add__, __mul__
+
+   {% block methods %}
+   {% if methods %}
+   .. rubric:: {{ _('Methods') }}
+
+   .. autosummary::
+      :nosignatures:
+   {% for item in methods %}
+      {%- if not item.startswith('_') %}
+      ~{{ name }}.{{ item }}
+      {%- endif -%}
+   {%- endfor %}
+   {% endif %}
+   {% endblock %}
+
+   {% block attributes %}
+   {% if attributes %}
+   .. rubric:: {{ _('Attributes') }}
+
+   .. autosummary::
+   {% for item in attributes %}
+      ~{{ name }}.{{ item }}
+   {%- endfor %}
+   {% endif %}
+   {% endblock %}
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 }}
+      :members:
+   {% 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:
+      :nosignatures:
+   {% for item in functions %}
+      {{ item }}
+   {%- endfor %}
+   {% endif %}
+   {% endblock %}
+
+   {% block classes %}
+   {% if classes %}
+   .. rubric:: {{ _('Classes') }}
+
+   .. autosummary::
+      :toctree:
+      :template: custom-class-template.rst
+      :nosignatures:
+   {% 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 %}
+.. autosummary::
+   :toctree:
+   :template: custom-module-template.rst
+   :recursive:
+{% for item in modules %}
+   {{ item }}
+{%- endfor %}
+{% endif %}
+{% endblock %}
diff --git a/docs/openfl.component.rst b/docs/openfl.component.rst
@@ -7,6 +7,7 @@
 
 .. autosummary::
    :toctree: _autosummary
+   :template: custom-module-template.rst
    :recursive:
 
    aggregator

diff --git a/docs/openfl.cryptography.rst b/docs/openfl.cryptography.rst
@@ -7,6 +7,7 @@
 
 .. autosummary::
    :toctree: _autosummary
+   :template: custom-module-template.rst
    :recursive:
 
    ca

diff --git a/docs/openfl.databases.rst b/docs/openfl.databases.rst
@@ -7,6 +7,7 @@
 
 .. autosummary::
    :toctree: _autosummary
+   :template: custom-module-template.rst
    :recursive:
 
    tensor_db

diff --git a/docs/openfl.experimental.rst b/docs/openfl.experimental.rst
@@ -7,6 +7,7 @@
 
 .. autosummary::
    :toctree: _autosummary
+   :template: custom-module-template.rst
    :recursive:
 
    workflow.interface

diff --git a/docs/openfl.federated.rst b/docs/openfl.federated.rst
@@ -7,6 +7,7 @@
 
 .. autosummary::
    :toctree: _autosummary
+   :template: custom-module-template.rst
    :recursive:
 
    plan

diff --git a/docs/openfl.interface.rst b/docs/openfl.interface.rst
@@ -7,6 +7,7 @@
 
 .. autosummary::
    :toctree: _autosummary
+   :template: custom-module-template.rst
    :recursive:
 
    aggregation_functions

diff --git a/docs/openfl.native.rst b/docs/openfl.native.rst
@@ -7,6 +7,7 @@
 
 .. autosummary::
    :toctree: _autosummary
+   :template: custom-module-template.rst
    :recursive:
 
    native

diff --git a/docs/openfl.pipelines.rst b/docs/openfl.pipelines.rst
@@ -7,6 +7,7 @@
 
 .. autosummary::
    :toctree: _autosummary
+   :template: custom-module-template.rst
    :recursive:
 
    eden_pipeline

diff --git a/docs/openfl.plugins.rst b/docs/openfl.plugins.rst
@@ -7,6 +7,7 @@
 
 .. autosummary::
    :toctree: _autosummary
+   :template: custom-module-template.rst
    :recursive:
 
    frameworks_adapters

diff --git a/docs/openfl.protocols.rst b/docs/openfl.protocols.rst
@@ -7,6 +7,7 @@
 
 .. autosummary::
    :toctree: _autosummary
+   :template: custom-module-template.rst
    :recursive:
 
    interceptors

diff --git a/docs/openfl.rst b/docs/openfl.rst
@@ -20,10 +20,4 @@ Subpackages
     openfl.plugins
     openfl.protocols
     openfl.transport
-    openfl.utilities
-
-
-.. toctree::
-   :hidden:
-
-   openfl.interface
+    openfl.utilities
diff --git a/docs/openfl.transport.rst b/docs/openfl.transport.rst
@@ -7,6 +7,7 @@
 
 .. autosummary::
    :toctree: _autosummary
+   :template: custom-module-template.rst
    :recursive:
 
    grpc
diff --git a/docs/openfl.utilities.rst b/docs/openfl.utilities.rst
@@ -8,6 +8,7 @@
 
 .. autosummary::
    :toctree: _autosummary
+   :template: custom-module-template.rst
    :recursive:
 
    ca