API docs as toctree

Signed-off-by: Shah, Karan <[email protected]>
securefederatedai · Dec 18, 2024 · 8cefb07 · 8cefb07
1 parent 3ab2362
commit 8cefb07
Show file tree

Hide file tree

Showing 20 changed files with 55 additions and 140 deletions.
diff --git a/docs/.gitignore b/docs/.gitignore
@@ -1,3 +1,3 @@
 /_build
 **/.ipynb_checkpoints
-source/api/_autosummary
+_autosummary
diff --git a/docs/_templates/custom-class-template.rst b/docs/_templates/custom-class-template.rst
diff --git a/docs/_templates/custom-module-template.rst b/docs/_templates/custom-module-template.rst
diff --git a/docs/_templates/layout.html b/docs/_templates/layout.html
@@ -0,0 +1 @@
+{% extends "!layout.html" %}
diff --git a/docs/developer_ref/api_documentation.rst b/docs/developer_ref/api_documentation.rst
diff --git a/docs/index.rst b/docs/index.rst
@@ -85,12 +85,12 @@ Round
    developer_guide/openfl_structure
 
 .. toctree::
-   :hidden:
-   :caption: API Reference
+   :hidden: 
+   :caption: Resources 
    :maxdepth: 2
 
-   developer_ref/api_documentation
-   developer_ref/troubleshooting
+   openfl
+   troubleshooting
 
 
 .. toctree::

diff --git a/docs/source/api/openfl.component.rst → docs/openfl.component.rst b/docs/source/api/openfl.component.rst → docs/openfl.component.rst
@@ -7,7 +7,6 @@
 
 .. autosummary::
    :toctree: _autosummary
-   :template: custom-module-template.rst
    :recursive:
 
    aggregator
@@ -16,3 +15,5 @@
    director
    envoy
    straggler_handling_functions
+
+.. TODO(MasterSkepticista) Shrink API namespace
diff --git a/docs/source/api/openfl.cryptography.rst → docs/openfl.cryptography.rst b/docs/source/api/openfl.cryptography.rst → docs/openfl.cryptography.rst
@@ -7,9 +7,10 @@
 
 .. autosummary::
    :toctree: _autosummary
-   :template: custom-module-template.rst
    :recursive:
 
    ca
    io
    participant
+
+.. TODO(MasterSkepticista) Shrink API namespace
diff --git a/docs/source/api/openfl.databases.rst → docs/openfl.databases.rst b/docs/source/api/openfl.databases.rst → docs/openfl.databases.rst
@@ -7,8 +7,9 @@
 
 .. autosummary::
    :toctree: _autosummary
-   :template: custom-module-template.rst
    :recursive:
 
    tensor_db
    utilities
+
+.. TODO(MasterSkepticista) Shrink API namespace
diff --git a/docs/source/api/openfl.experimental.rst → docs/openfl.experimental.rst b/docs/source/api/openfl.experimental.rst → docs/openfl.experimental.rst
@@ -7,10 +7,11 @@
 
 .. autosummary::
    :toctree: _autosummary
-   :template: custom-module-template.rst
    :recursive:
 
    workflow.interface
    workflow.placement
    workflow.runtime
    workflow.utilities
+
+.. TODO(MasterSkepticista) Shrink API namespace
diff --git a/docs/source/api/openfl.federated.rst → docs/openfl.federated.rst b/docs/source/api/openfl.federated.rst → docs/openfl.federated.rst
@@ -7,9 +7,10 @@
 
 .. autosummary::
    :toctree: _autosummary
-   :template: custom-module-template.rst
    :recursive:
 
    plan
    task
    data
+
+.. TODO(MasterSkepticista) Shrink API namespace
diff --git a/docs/source/api/openfl.interface.rst → docs/openfl.interface.rst b/docs/source/api/openfl.interface.rst → docs/openfl.interface.rst
@@ -7,7 +7,6 @@
 
 .. autosummary::
    :toctree: _autosummary
-   :template: custom-module-template.rst
    :recursive:
 
    aggregation_functions
@@ -23,3 +22,5 @@
    plan
    tutorial
    workspace
+
+.. TODO(MasterSkepticista) Shrink API namespace
diff --git a/docs/source/api/openfl.native.rst → docs/openfl.native.rst b/docs/source/api/openfl.native.rst → docs/openfl.native.rst
@@ -7,8 +7,9 @@
 
 .. autosummary::
    :toctree: _autosummary
-   :template: custom-module-template.rst
    :recursive:
 
    native
    fastestimator
+
+.. TODO(MasterSkepticista) Shrink API namespace
diff --git a/docs/source/api/openfl.pipelines.rst → docs/openfl.pipelines.rst b/docs/source/api/openfl.pipelines.rst → docs/openfl.pipelines.rst
@@ -7,7 +7,6 @@
 
 .. autosummary::
    :toctree: _autosummary
-   :template: custom-module-template.rst
    :recursive:
 
    eden_pipeline
@@ -18,3 +17,5 @@
    skc_pipeline
    stc_pipeline
    tensor_codec
+
+.. TODO(MasterSkepticista) Shrink API namespace
diff --git a/docs/source/api/openfl.plugins.rst → docs/openfl.plugins.rst b/docs/source/api/openfl.plugins.rst → docs/openfl.plugins.rst
@@ -7,9 +7,10 @@
 
 .. autosummary::
    :toctree: _autosummary
-   :template: custom-module-template.rst
    :recursive:
 
    frameworks_adapters
    interface_serializer
    processing_units_monitor
+
+.. TODO(MasterSkepticista) Shrink API namespace
diff --git a/docs/source/api/openfl.protocols.rst → docs/openfl.protocols.rst b/docs/source/api/openfl.protocols.rst → docs/openfl.protocols.rst
@@ -7,8 +7,9 @@
 
 .. autosummary::
    :toctree: _autosummary
-   :template: custom-module-template.rst
    :recursive:
 
    interceptors
    utils
+
+.. TODO(MasterSkepticista) Shrink API namespace
diff --git a/docs/openfl.rst b/docs/openfl.rst
@@ -0,0 +1,29 @@
+.. currentmodule:: openfl
+
+Public API: ``openfl`` package
+===========================
+
+Subpackages
+-----------
+
+.. toctree::
+    :maxdepth: 1
+
+    openfl.component
+    openfl.cryptography
+    openfl.experimental
+    openfl.databases
+    openfl.federated
+    openfl.interface
+    openfl.native
+    openfl.pipelines
+    openfl.plugins
+    openfl.protocols
+    openfl.transport
+    openfl.utilities
+
+
+.. toctree::
+   :hidden:
+
+   openfl.interface
diff --git a/docs/source/api/openfl.transport.rst → docs/openfl.transport.rst b/docs/source/api/openfl.transport.rst → docs/openfl.transport.rst
@@ -7,7 +7,6 @@
 
 .. autosummary::
    :toctree: _autosummary
-   :template: custom-module-template.rst
    :recursive:
 
    grpc
diff --git a/docs/source/api/openfl.utilities.rst → docs/openfl.utilities.rst b/docs/source/api/openfl.utilities.rst → docs/openfl.utilities.rst
@@ -8,7 +8,6 @@
 
 .. autosummary::
    :toctree: _autosummary
-   :template: custom-module-template.rst
    :recursive:
 
    ca

diff --git a/docs/developer_ref/troubleshooting.rst → docs/troubleshooting.rst b/docs/developer_ref/troubleshooting.rst → docs/troubleshooting.rst