Auto generate rst documentation

resurfemg-org · Nov 6, 2024 · 432fc3d · 432fc3d
1 parent a602f11
commit 432fc3d
Show file tree

Hide file tree

Showing 24 changed files with 89 additions and 95 deletions.
diff --git a/README.md b/README.md
@@ -264,7 +264,7 @@ https://github.com/ReSurfEMG/ReSurfEMG-dashboard
 
 * `isort resurfemg --check --diff` checks that the imports are properly 
   formatted and sorted.
-* `setup.py apidoc` generates RST outlines necessary to generate
+* `python setup.py apidoc` generates RST outlines necessary to generate
   documentation.
 
 ### Testing

diff --git a/docs/resurfemg.config.config.rst b/docs/resurfemg.config.config.rst
diff --git a/docs/resurfemg.config.rst b/docs/resurfemg.config.rst
diff --git a/docs/resurfemg.data_classes.data_classes.rst b/docs/resurfemg.data_classes.data_classes.rst
diff --git a/docs/resurfemg.data_classes.rst b/docs/resurfemg.data_classes.rst
diff --git a/docs/resurfemg.data_connector.config.rst b/docs/resurfemg.data_connector.config.rst
@@ -0,0 +1,7 @@
+resurfemg.data\_connector.config module
+=======================================
+
+.. automodule:: resurfemg.data_connector.config
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/resurfemg.data_connector.data_classes.rst b/docs/resurfemg.data_connector.data_classes.rst
@@ -0,0 +1,7 @@
+resurfemg.data\_connector.data\_classes module
+==============================================
+
+.. automodule:: resurfemg.data_connector.data_classes
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/resurfemg.data_connector.file_discovery.rst b/docs/resurfemg.data_connector.file_discovery.rst
@@ -0,0 +1,7 @@
+resurfemg.data\_connector.file\_discovery module
+================================================
+
+.. automodule:: resurfemg.data_connector.file_discovery
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/resurfemg.data_connector.peakset_class.rst b/docs/resurfemg.data_connector.peakset_class.rst
@@ -0,0 +1,7 @@
+resurfemg.data\_connector.peakset\_class module
+===============================================
+
+.. automodule:: resurfemg.data_connector.peakset_class
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/resurfemg.data_connector.rst b/docs/resurfemg.data_connector.rst
@@ -7,7 +7,12 @@ Submodules
 .. toctree::
    :maxdepth: 4
 
+   resurfemg.data_connector.config
    resurfemg.data_connector.converter_functions
+   resurfemg.data_connector.data_classes
+   resurfemg.data_connector.file_discovery
+   resurfemg.data_connector.peakset_class
+   resurfemg.data_connector.synthetic_data
    resurfemg.data_connector.tmsisdk_lite
 
 Module contents

diff --git a/docs/resurfemg.data_connector.synthetic_data.rst b/docs/resurfemg.data_connector.synthetic_data.rst
@@ -0,0 +1,7 @@
+resurfemg.data\_connector.synthetic\_data module
+================================================
+
+.. automodule:: resurfemg.data_connector.synthetic_data
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/resurfemg.helper_functions.data_classes_quality_assessment.rst b/docs/resurfemg.helper_functions.data_classes_quality_assessment.rst
@@ -0,0 +1,7 @@
+resurfemg.helper\_functions.data\_classes\_quality\_assessment module
+=====================================================================
+
+.. automodule:: resurfemg.helper_functions.data_classes_quality_assessment
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/resurfemg.helper_functions.helper_functions.rst b/docs/resurfemg.helper_functions.helper_functions.rst
diff --git a/docs/resurfemg.helper_functions.math_operations.rst b/docs/resurfemg.helper_functions.math_operations.rst
@@ -0,0 +1,7 @@
+resurfemg.helper\_functions.math\_operations module
+===================================================
+
+.. automodule:: resurfemg.helper_functions.math_operations
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/resurfemg.helper_functions.rst b/docs/resurfemg.helper_functions.rst
@@ -7,7 +7,9 @@ Submodules
 .. toctree::
    :maxdepth: 4
 
-   resurfemg.helper_functions.helper_functions
+   resurfemg.helper_functions.data_classes_quality_assessment
+   resurfemg.helper_functions.math_operations
+   resurfemg.helper_functions.visualization
 
 Module contents
 ---------------

diff --git a/docs/resurfemg.helper_functions.visualization.rst b/docs/resurfemg.helper_functions.visualization.rst
@@ -0,0 +1,7 @@
+resurfemg.helper\_functions.visualization module
+================================================
+
+.. automodule:: resurfemg.helper_functions.visualization
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/resurfemg.pipelines.ipy_widgets.rst b/docs/resurfemg.pipelines.ipy_widgets.rst
@@ -0,0 +1,7 @@
+resurfemg.pipelines.ipy\_widgets module
+=======================================
+
+.. automodule:: resurfemg.pipelines.ipy_widgets
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/resurfemg.pipelines.pipelines.rst b/docs/resurfemg.pipelines.pipelines.rst
diff --git a/docs/resurfemg.pipelines.processing.rst b/docs/resurfemg.pipelines.processing.rst
@@ -0,0 +1,7 @@
+resurfemg.pipelines.processing module
+=====================================
+
+.. automodule:: resurfemg.pipelines.processing
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/resurfemg.pipelines.rst b/docs/resurfemg.pipelines.rst
@@ -7,7 +7,9 @@ Submodules
 .. toctree::
    :maxdepth: 4
 
-   resurfemg.pipelines.pipelines
+   resurfemg.pipelines.ipy_widgets
+   resurfemg.pipelines.processing
+   resurfemg.pipelines.synthetic_data
 
 Module contents
 ---------------

diff --git a/docs/resurfemg.pipelines.synthetic_data.rst b/docs/resurfemg.pipelines.synthetic_data.rst
@@ -0,0 +1,7 @@
+resurfemg.pipelines.synthetic\_data module
+==========================================
+
+.. automodule:: resurfemg.pipelines.synthetic_data
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/resurfemg.rst b/docs/resurfemg.rst
@@ -8,14 +8,11 @@ Subpackages
    :maxdepth: 4
 
    resurfemg.cli
-   resurfemg.config
-   resurfemg.data_classes
    resurfemg.data_connector
    resurfemg.helper_functions
    resurfemg.pipelines
    resurfemg.postprocessing
    resurfemg.preprocessing
-   resurfemg.visualization
 
 Module contents
 ---------------

diff --git a/docs/resurfemg.visualization.rst b/docs/resurfemg.visualization.rst
diff --git a/docs/resurfemg.visualization.visualization.rst b/docs/resurfemg.visualization.visualization.rst