securefederatedai · manuelhsantana · Nov 27, 2023 · Nov 27, 2023 · Nov 27, 2023 · Nov 28, 2023
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/conf.py b/docs/conf.py
@@ -31,16 +31,19 @@
 # import sphinxcontrib.napoleon # NOQA:E800
 
 extensions = [
+    'sphinx.ext.napoleon',
     'sphinx_rtd_theme',
     'sphinx.ext.autosectionlabel',
-    'sphinx.ext.napoleon',
     'sphinx-prompt',
     'sphinx_copybutton',
     'sphinx_substitution_extensions',
     'sphinx.ext.ifconfig',
     'sphinxcontrib.mermaid',
+    'sphinx.ext.autodoc',
+    'sphinx.ext.autosummary',
     'recommonmark'
 ]
+autosummary_generate = True  # Turn on sphinx.ext.autosummary
 
 source_suffix = ['.rst', '.md']
 
@@ -68,14 +71,46 @@
 
 napoleon_google_docstring = True
 
+# 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']
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 # This pattern also affects html_static_path and html_extra_path.
 exclude_patterns = ['_build', 'Thumbs.db', 'README.md', 'structurizer_dsl/README.md',
-                    '.DS_Store', 'tutorials/*', 'graveyard/*']
+                    '.DS_Store', 'tutorials/*', 'graveyard/*', '_templates']
+
 # add temporary unused files
 exclude_patterns.extend(['modules.rst',
                          'install.singularity.rst',

diff --git a/docs/developer_ref/api_documentation.rst b/docs/developer_ref/api_documentation.rst
@@ -1,10 +1,33 @@
-.. # Copyright (C) 2020-2023 Intel Corporation
-.. # SPDX-License-Identifier: Apache-2.0
-
-*************************************************
-|productName| API
-*************************************************
-
-Welcome to the |productName| API reference:
-
-TODO
+.. # Copyright (C) 2020-2024 Intel Corporation
+.. # SPDX-License-Identifier: Apache-2.0
+
+*************************************************
+|productName| API
+*************************************************
+
+Welcome to the |productName| 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`
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
diff --git a/docs/index.rst b/docs/index.rst
@@ -64,12 +64,4 @@ Looking for the Open Flash Library project also referred to as OpenFL? Find it `
    :caption: CONTRIBUTING GUIDELINES
    :maxdepth: 2
 
-   contributing_guidelines/contributing
-
-
-.. Indices and tables
-.. ==================
-
-.. * :ref:`genindex`
-.. * :ref:`modindex`
-.. * :ref:`search`
+   contributing_guidelines/contributing   
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
+