docs(ReadTheDocs): adapt documentation to new package and module stru…

…cture
Met4FoF · Jul 7, 2021 · ab207c4 · ab207c4
1 parent 88246ad
commit ab207c4
Show file tree

Hide file tree

Showing 7 changed files with 67 additions and 17 deletions.
diff --git a/docs/agentMET4FOF_agents.rst b/docs/agentMET4FOF_agents.rst
@@ -1,5 +1,29 @@
 agentMET4FOF agents
 ===================
 
-.. automodule:: agentMET4FOF.agents
+Base agents
+-----------
+.. automodule:: agentMET4FOF.agents.base_agents
     :members:
+    :private-members:
+
+
+Signal agents
+-------------
+.. automodule:: agentMET4FOF.agents.signal_agents
+    :members:
+    :private-members:
+
+
+Metrologically enabled base agents
+----------------------------------
+.. automodule:: agentMET4FOF.agents.metrological_base_agents
+    :members:
+    :private-members:
+
+
+Metrologically enabled signal agents
+------------------------------------
+.. automodule:: agentMET4FOF.agents.metrological_signal_agents
+    :members:
+    :private-members:
diff --git a/docs/agentMET4FOF_metrological_agents.rst b/docs/agentMET4FOF_metrological_agents.rst
diff --git a/docs/agentMET4FOF_metrological_streams.rst b/docs/agentMET4FOF_metrological_streams.rst
diff --git a/docs/agentMET4FOF_network.rst b/docs/agentMET4FOF_network.rst
@@ -0,0 +1,6 @@
+agentMET4FOF agent network
+==========================
+
+.. automodule:: agentMET4FOF.network
+    :members:
+    :private-members:
diff --git a/docs/agentMET4FOF_streams.rst b/docs/agentMET4FOF_streams.rst
@@ -1,6 +1,29 @@
 agentMET4FOF streams
 ====================
 
-.. automodule:: agentMET4FOF.streams
+Base streams
+------------
+.. automodule:: agentMET4FOF.streams.base_streams
+    :members:
+    :private-members:
+
+
+Signal streams
+--------------
+.. automodule:: agentMET4FOF.streams.signal_streams
+    :members:
+    :private-members:
+
+
+Metrologically enabled base streams
+-----------------------------------
+.. automodule:: agentMET4FOF.streams.metrological_base_streams
+    :members:
+    :private-members:
+
+
+Metrologically enabled signal streams
+------------------------------------
+.. automodule:: agentMET4FOF.streams.metrological_signal_streams
     :members:
     :private-members:
diff --git a/docs/agentMET4FOF_utilities.rst b/docs/agentMET4FOF_utilities.rst
@@ -0,0 +1,8 @@
+agentMET4FOF utilities
+======================
+
+Buffering for agents
+--------------------
+.. automodule:: agentMET4FOF.utils.buffer
+    :members:
+    :private-members:
diff --git a/docs/index.rst b/docs/index.rst
@@ -1,6 +1,6 @@
 :github_url: https://github.com/Met4FoF/agentMET4FOF
 
-agentMET4FOF - Metrological Agent-based system
+agentMET4FOF - Metrological agent-based system
 ==============================================
 
 .. toctree::
@@ -13,6 +13,7 @@ agentMET4FOF - Metrological Agent-based system
    CONTRIBUTING
    CHANGELOG
 
+
 .. toctree::
    :maxdepth: 1
    :caption: Tutorials:
@@ -32,9 +33,9 @@ agentMET4FOF - Metrological Agent-based system
 
    agentMET4FOF_agents
    agentMET4FOF_streams
-   agentMET4FOF_metrological_agents
-   agentMET4FOF_metrological_streams
    agentMET4FOF_dashboard
+   agentMET4FOF_network
+   agentMET4FOF_utilities
 
 Indices and tables
 ==================