Updated modules configuration for docstrings API documentation

Signed-off-by: manuelhsantana <[email protected]>
securefederatedai · Jul 9, 2024 · 14a8deb · 14a8deb
1 parent deca2ff
commit 14a8deb
Show file tree

Hide file tree

Showing 15 changed files with 239 additions and 10 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -31,9 +31,9 @@
 # import sphinxcontrib.napoleon # NOQA:E800
 
 extensions = [
+    'sphinx.ext.napoleon',
     'sphinx_rtd_theme',
     'sphinx.ext.autosectionlabel',
-    'sphinx.ext.napoleon',
     'sphinx-prompt',
     'sphinx_substitution_extensions',
     'sphinx.ext.ifconfig',
@@ -70,6 +70,33 @@
 # Config the returns section to behave like the Args section
 napoleon_custom_sections = [('Returns', 'params_style')]
 
+# This code extends Sphinx's GoogleDocstring class to support 'Keys', 'Attributes', 
+# and 'Class Attributes' sections in docstrings. Allows for more detailed and structured 
+# documentation of Python classes and their attributes.
+from sphinx.ext.napoleon.docstring import GoogleDocstring
+
+# Define new sections and their corresponding parse methods
+new_sections = {
+    'keys': 'Keys',
+    'attributes': 'Attributes',
+    'class attributes': 'Class Attributes'
+}
+
+# Add new sections to GoogleDocstring class
+for section, title in new_sections.items():
+    setattr(GoogleDocstring, f'_parse_{section}_section',
+            lambda self, section: self._format_fields(title, self._consume_fields()))
+
+# Patch the parse method to include new sections
+def patched_parse(self):
+    for section in new_sections:
+        self._sections[section] = getattr(self, f'_parse_{section}_section')
+    self._unpatched_parse()
+
+# Apply the patch
+GoogleDocstring._unpatched_parse = GoogleDocstring._parse
+GoogleDocstring._parse = patched_parse
+
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
 

diff --git a/docs/index.rst b/docs/index.rst
@@ -23,7 +23,7 @@ Training of statistical models may be done with any deep learning framework, suc
 Looking for the Open Flash Library project also referred to as OpenFL? Find it [here](https://www.openfl.org/)!
 
 .. toctree::
-   :maxdepth: 1
+   :maxdepth: 2
    :caption: Contents:
 
    manual
@@ -38,4 +38,5 @@ Indices and tables
 
 * :ref:`genindex`
 * :ref:`modindex`
+
 .. * :ref:`search`
diff --git a/docs/openfl_api.rst b/docs/openfl_api.rst
@@ -12,11 +12,15 @@ Welcome to the |productName| API reference:
    :template: custom-module-template.rst
    :recursive:
 
-   openfl.component.aggregator
-   openfl.component.assigner
-   openfl.component.collaborator
-   openfl.component.director
-   openfl.component.envoy
-   openfl.component.straggler_handling_functions
-
-   - :doc:`openfl.component`
+- :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/source/api/openfl_component.rst b/docs/source/api/openfl_component.rst
@@ -0,0 +1,20 @@
+.. # Copyright (C) 2020-2024 Intel Corporation
+.. # SPDX-License-Identifier: Apache-2.0
+
+*************************************************
+Component Module
+*************************************************
+
+Component modules reference:
+
+.. autosummary::
+   :toctree: _autosummary
+   :template: custom-module-template.rst
+   :recursive:
+
+   openfl.component.aggregator
+   openfl.component.assigner
+   openfl.component.collaborator
+   openfl.component.director
+   openfl.component.envoy
+   openfl.component.straggler_handling_functions
diff --git a/docs/source/api/openfl_cryptography.rst b/docs/source/api/openfl_cryptography.rst
@@ -0,0 +1,16 @@
+.. # Copyright (C) 2020-2024 Intel Corporation
+.. # SPDX-License-Identifier: Apache-2.0
+
+*************************************************
+Cryptography Module
+*************************************************
+
+Cryptography modules reference:
+
+.. autosummary::
+   :toctree: _autosummary
+   :recursive:
+
+   openfl.cryptography.ca
+   openfl.cryptography.io
+   openfl.cryptography.participant
diff --git a/docs/source/api/openfl_databases.rst b/docs/source/api/openfl_databases.rst
@@ -0,0 +1,16 @@
+.. # Copyright (C) 2020-2024 Intel Corporation
+.. # SPDX-License-Identifier: Apache-2.0
+
+*************************************************
+Databases Module
+*************************************************
+
+Databases modules reference:
+
+.. autosummary::
+   :toctree: _autosummary
+   :template: custom-module-template.rst
+   :recursive:
+
+   openfl.databases
+
diff --git a/docs/source/api/openfl_experimental.rst b/docs/source/api/openfl_experimental.rst
@@ -0,0 +1,18 @@
+.. # Copyright (C) 2020-2024 Intel Corporation
+.. # SPDX-License-Identifier: Apache-2.0
+
+*************************************************
+Experimental Module
+*************************************************
+
+Experimental modules reference:
+
+.. autosummary::
+   :toctree: _autosummary
+   :template: custom-module-template.rst
+   :recursive:
+
+   openfl.experimental.interface
+   openfl.experimental.placement
+   openfl.experimental.runtime
+   openfl.experimental.utilities
diff --git a/docs/source/api/openfl_federated.rst b/docs/source/api/openfl_federated.rst
@@ -0,0 +1,16 @@
+.. # Copyright (C) 2020-2024 Intel Corporation
+.. # SPDX-License-Identifier: Apache-2.0
+
+*************************************************
+Federated Module
+*************************************************
+
+Federated modules reference:
+
+.. autosummary::
+   :toctree: _autosummary
+   :template: custom-module-template.rst
+   :recursive:
+
+   openfl.federated
+
diff --git a/docs/source/api/openfl_interface.rst b/docs/source/api/openfl_interface.rst
@@ -0,0 +1,16 @@
+.. # Copyright (C) 2020-2024 Intel Corporation
+.. # SPDX-License-Identifier: Apache-2.0
+
+*************************************************
+Interface Module
+*************************************************
+
+Interface modules reference:
+
+.. autosummary::
+   :toctree: _autosummary
+   :template: custom-module-template.rst
+   :recursive:
+
+   openfl.interface
+
diff --git a/docs/source/api/openfl_native.rst b/docs/source/api/openfl_native.rst
@@ -0,0 +1,16 @@
+.. # Copyright (C) 2020-2024 Intel Corporation
+.. # SPDX-License-Identifier: Apache-2.0
+
+*************************************************
+Native Module
+*************************************************
+
+Native modules reference:
+
+.. autosummary::
+   :toctree: _autosummary
+   :template: custom-module-template.rst
+   :recursive:
+
+   openfl.native
+
diff --git a/docs/source/api/openfl_pipelines.rst b/docs/source/api/openfl_pipelines.rst
@@ -0,0 +1,16 @@
+.. # Copyright (C) 2020-2024 Intel Corporation
+.. # SPDX-License-Identifier: Apache-2.0
+
+*************************************************
+Pipelines Module
+*************************************************
+
+Pipelines modules reference:
+
+.. autosummary::
+   :toctree: _autosummary
+   :template: custom-module-template.rst
+   :recursive:
+
+   openfl.pipelines
+
diff --git a/docs/source/api/openfl_plugins.rst b/docs/source/api/openfl_plugins.rst
@@ -0,0 +1,16 @@
+.. # Copyright (C) 2020-2024 Intel Corporation
+.. # SPDX-License-Identifier: Apache-2.0
+
+*************************************************
+Plugins Module
+*************************************************
+
+Plugins modules reference:
+
+.. autosummary::
+   :toctree: _autosummary
+   :template: custom-module-template.rst
+   :recursive:
+
+   openfl.plugins
+
diff --git a/docs/source/api/openfl_protocols.rst b/docs/source/api/openfl_protocols.rst
@@ -0,0 +1,16 @@
+.. # Copyright (C) 2020-2024 Intel Corporation
+.. # SPDX-License-Identifier: Apache-2.0
+
+*************************************************
+Protocols Module
+*************************************************
+
+Protocols modules reference:
+
+.. autosummary::
+   :toctree: _autosummary
+   :template: custom-module-template.rst
+   :recursive:
+
+   openfl.protocols
+
diff --git a/docs/source/api/openfl_transport.rst b/docs/source/api/openfl_transport.rst
@@ -0,0 +1,15 @@
+.. # Copyright (C) 2020-2024 Intel Corporation
+.. # SPDX-License-Identifier: Apache-2.0
+
+*************************************************
+Transport Module
+*************************************************
+
+Transport modules reference:
+
+.. autosummary::
+   :toctree: _autosummary
+   :template: custom-module-template.rst
+   :recursive:
+
+   openfl.transport
diff --git a/docs/source/api/openfl_utilities.rst b/docs/source/api/openfl_utilities.rst
@@ -0,0 +1,16 @@
+.. # Copyright (C) 2020-2024 Intel Corporation
+.. # SPDX-License-Identifier: Apache-2.0
+
+*************************************************
+Utilities Module
+*************************************************
+
+Utilities modules reference:
+
+.. autosummary::
+   :toctree: _autosummary
+   :template: custom-module-template.rst
+   :recursive:
+
+   openfl.utilities
+