docs(data_handling): expand documentation

Add documentation for new scripts.data_handling.process module.
IMS-Bio2Core-Facility · Jun 10, 2021 · f072312 · f072312
1 parent 16d96e7
commit f072312
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 1 deletion.
diff --git a/docs/data_handling.rst b/docs/data_handling.rst
@@ -0,0 +1,13 @@
+.. _data_handling:
+
+data_handling Module
+====================
+
+.. automodule:: scripts.data_handling
+
+data_handling.process
+---------------------
+
+.. automodule:: scripts.data_handling.process
+   :members:
+   :private-members:
diff --git a/docs/source.rst b/docs/source.rst
@@ -3,18 +3,22 @@
 Source Code
 ===========
 
-The source code is currently divided into 3 modules:
+The source code is currently divided into 4 modules:
 
 #. Top-level analysis in the root ``scripts`` modules.
    They are documented under :ref:`analysis`.
 #. ``logs`` submodule, containing code related to logging configuration.
    See :ref:`logs`.
+#. ``data_handling`` contains the code for manipulating query data.
+   See :ref:`data_handling`.
 #. ``multithreading`` submodule, containing code related to concurrency.
    See :ref:`multithreading`.
 
 .. toctree::
    :hidden:
    :maxdepth: 3
 
+   analysis
    logging
+   data_handling
    multithreading