From 8cefb07774a7fdd2cb4d30dab3ed817f83d8fe35 Mon Sep 17 00:00:00 2001 From: "Shah, Karan" Date: Wed, 18 Dec 2024 13:10:32 +0530 Subject: [PATCH] API docs as toctree Signed-off-by: Shah, Karan --- docs/.gitignore | 2 +- docs/_templates/custom-class-template.rst | 34 ---------- docs/_templates/custom-module-template.rst | 66 ------------------- docs/_templates/layout.html | 1 + docs/developer_ref/api_documentation.rst | 23 ------- docs/index.rst | 8 +-- docs/{source/api => }/openfl.component.rst | 3 +- docs/{source/api => }/openfl.cryptography.rst | 3 +- docs/{source/api => }/openfl.databases.rst | 3 +- docs/{source/api => }/openfl.experimental.rst | 3 +- docs/{source/api => }/openfl.federated.rst | 3 +- docs/{source/api => }/openfl.interface.rst | 3 +- docs/{source/api => }/openfl.native.rst | 3 +- docs/{source/api => }/openfl.pipelines.rst | 3 +- docs/{source/api => }/openfl.plugins.rst | 3 +- docs/{source/api => }/openfl.protocols.rst | 3 +- docs/openfl.rst | 29 ++++++++ docs/{source/api => }/openfl.transport.rst | 1 - docs/{source/api => }/openfl.utilities.rst | 1 - docs/{developer_ref => }/troubleshooting.rst | 0 20 files changed, 55 insertions(+), 140 deletions(-) delete mode 100644 docs/_templates/custom-class-template.rst delete mode 100644 docs/_templates/custom-module-template.rst create mode 100644 docs/_templates/layout.html delete mode 100644 docs/developer_ref/api_documentation.rst rename docs/{source/api => }/openfl.component.rst (85%) rename docs/{source/api => }/openfl.cryptography.rst (82%) rename docs/{source/api => }/openfl.databases.rst (81%) rename docs/{source/api => }/openfl.experimental.rst (85%) rename docs/{source/api => }/openfl.federated.rst (81%) rename docs/{source/api => }/openfl.interface.rst (87%) rename docs/{source/api => }/openfl.native.rst (82%) rename docs/{source/api => }/openfl.pipelines.rst (87%) rename docs/{source/api => }/openfl.plugins.rst (83%) rename docs/{source/api => }/openfl.protocols.rst (81%) create mode 100644 docs/openfl.rst rename docs/{source/api => }/openfl.transport.rst (82%) rename docs/{source/api => }/openfl.utilities.rst (90%) rename docs/{developer_ref => }/troubleshooting.rst (100%) diff --git a/docs/.gitignore b/docs/.gitignore index 87033ff2d0..c6b43d1085 100644 --- a/docs/.gitignore +++ b/docs/.gitignore @@ -1,3 +1,3 @@ /_build **/.ipynb_checkpoints -source/api/_autosummary \ No newline at end of file +_autosummary \ No newline at end of file diff --git a/docs/_templates/custom-class-template.rst b/docs/_templates/custom-class-template.rst deleted file mode 100644 index d64b80d51c..0000000000 --- a/docs/_templates/custom-class-template.rst +++ /dev/null @@ -1,34 +0,0 @@ -{{ 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 %} \ No newline at end of file diff --git a/docs/_templates/custom-module-template.rst b/docs/_templates/custom-module-template.rst deleted file mode 100644 index ec6b7ab05d..0000000000 --- a/docs/_templates/custom-module-template.rst +++ /dev/null @@ -1,66 +0,0 @@ -{{ 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 %} \ No newline at end of file diff --git a/docs/_templates/layout.html b/docs/_templates/layout.html new file mode 100644 index 0000000000..18b4901203 --- /dev/null +++ b/docs/_templates/layout.html @@ -0,0 +1 @@ +{% extends "!layout.html" %} \ No newline at end of file diff --git a/docs/developer_ref/api_documentation.rst b/docs/developer_ref/api_documentation.rst deleted file mode 100644 index 571a9dad5f..0000000000 --- a/docs/developer_ref/api_documentation.rst +++ /dev/null @@ -1,23 +0,0 @@ -.. # Copyright (C) 2020-2024 Intel Corporation -.. # SPDX-License-Identifier: Apache-2.0 - -API Reference -============= - -.. autosummary:: - :toctree: _autosummary - :template: custom-module-template.rst - :recursive: - -- :doc:`../source/api/openfl.component` -- :doc:`../source/api/openfl.cryptography` -- :doc:`../source/api/openfl.databases` -- :doc:`../source/api/openfl.experimental` -- :doc:`../source/api/openfl.federated` -- :doc:`../source/api/openfl.interface` -- :doc:`../source/api/openfl.native` -- :doc:`../source/api/openfl.pipelines` -- :doc:`../source/api/openfl.plugins` -- :doc:`../source/api/openfl.protocols` -- :doc:`../source/api/openfl.transport` -- :doc:`../source/api/openfl.utilities` diff --git a/docs/index.rst b/docs/index.rst index e87a0d732c..22fde9e043 100644 --- 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 b/docs/openfl.component.rst similarity index 85% rename from docs/source/api/openfl.component.rst rename to docs/openfl.component.rst index 12d506280a..4d440fa0b6 100644 --- a/docs/source/api/openfl.component.rst +++ b/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 b/docs/openfl.cryptography.rst similarity index 82% rename from docs/source/api/openfl.cryptography.rst rename to docs/openfl.cryptography.rst index 9385f7a1b3..debc2c36a9 100644 --- a/docs/source/api/openfl.cryptography.rst +++ b/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 b/docs/openfl.databases.rst similarity index 81% rename from docs/source/api/openfl.databases.rst rename to docs/openfl.databases.rst index 7835cd2d6d..00f6470041 100644 --- a/docs/source/api/openfl.databases.rst +++ b/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 b/docs/openfl.experimental.rst similarity index 85% rename from docs/source/api/openfl.experimental.rst rename to docs/openfl.experimental.rst index e0eb7b7d94..6f23333447 100644 --- a/docs/source/api/openfl.experimental.rst +++ b/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 b/docs/openfl.federated.rst similarity index 81% rename from docs/source/api/openfl.federated.rst rename to docs/openfl.federated.rst index 51de926498..7eb0f482e3 100644 --- a/docs/source/api/openfl.federated.rst +++ b/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 b/docs/openfl.interface.rst similarity index 87% rename from docs/source/api/openfl.interface.rst rename to docs/openfl.interface.rst index 8bf056df7d..a176d14787 100644 --- a/docs/source/api/openfl.interface.rst +++ b/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 b/docs/openfl.native.rst similarity index 82% rename from docs/source/api/openfl.native.rst rename to docs/openfl.native.rst index ad8f0a98dd..a16b26fe6d 100644 --- a/docs/source/api/openfl.native.rst +++ b/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 b/docs/openfl.pipelines.rst similarity index 87% rename from docs/source/api/openfl.pipelines.rst rename to docs/openfl.pipelines.rst index 6fa919139e..21ecbea62c 100644 --- a/docs/source/api/openfl.pipelines.rst +++ b/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 b/docs/openfl.plugins.rst similarity index 83% rename from docs/source/api/openfl.plugins.rst rename to docs/openfl.plugins.rst index 05289d2f9a..1985f97509 100644 --- a/docs/source/api/openfl.plugins.rst +++ b/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 b/docs/openfl.protocols.rst similarity index 81% rename from docs/source/api/openfl.protocols.rst rename to docs/openfl.protocols.rst index 0ffa818de7..9425a9ada9 100644 --- a/docs/source/api/openfl.protocols.rst +++ b/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 new file mode 100644 index 0000000000..6b7430752f --- /dev/null +++ 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 b/docs/openfl.transport.rst similarity index 82% rename from docs/source/api/openfl.transport.rst rename to docs/openfl.transport.rst index 5ec55236ed..4ae89ba05d 100644 --- a/docs/source/api/openfl.transport.rst +++ b/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 b/docs/openfl.utilities.rst similarity index 90% rename from docs/source/api/openfl.utilities.rst rename to docs/openfl.utilities.rst index 8e970bf3ab..0b527d8682 100644 --- a/docs/source/api/openfl.utilities.rst +++ b/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 b/docs/troubleshooting.rst similarity index 100% rename from docs/developer_ref/troubleshooting.rst rename to docs/troubleshooting.rst