diff --git a/README.md b/README.md index ddb60d8c..156bb05a 100644 --- 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 deleted file mode 100644 index 0b16a951..00000000 --- a/docs/resurfemg.config.config.rst +++ /dev/null @@ -1,7 +0,0 @@ -resurfemg.config.config module -============================== - -.. automodule:: resurfemg.config.config - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/resurfemg.config.rst b/docs/resurfemg.config.rst deleted file mode 100644 index 9b238923..00000000 --- a/docs/resurfemg.config.rst +++ /dev/null @@ -1,18 +0,0 @@ -resurfemg.config package -======================== - -Submodules ----------- - -.. toctree:: - :maxdepth: 4 - - resurfemg.config.config - -Module contents ---------------- - -.. automodule:: resurfemg.config - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/resurfemg.data_classes.data_classes.rst b/docs/resurfemg.data_classes.data_classes.rst deleted file mode 100644 index 38c0f63e..00000000 --- a/docs/resurfemg.data_classes.data_classes.rst +++ /dev/null @@ -1,7 +0,0 @@ -resurfemg.data\_classes.data\_classes module -============================================ - -.. automodule:: resurfemg.data_classes.data_classes - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/resurfemg.data_classes.rst b/docs/resurfemg.data_classes.rst deleted file mode 100644 index eca949f2..00000000 --- a/docs/resurfemg.data_classes.rst +++ /dev/null @@ -1,18 +0,0 @@ -resurfemg.data\_classes package -=============================== - -Submodules ----------- - -.. toctree:: - :maxdepth: 4 - - resurfemg.data_classes.data_classes - -Module contents ---------------- - -.. automodule:: resurfemg.data_classes - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/resurfemg.data_connector.config.rst b/docs/resurfemg.data_connector.config.rst new file mode 100644 index 00000000..471ebd82 --- /dev/null +++ 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 new file mode 100644 index 00000000..c97be3ad --- /dev/null +++ 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 new file mode 100644 index 00000000..788d6535 --- /dev/null +++ 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 new file mode 100644 index 00000000..4eff7e16 --- /dev/null +++ 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 index e922492c..5146350e 100644 --- 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 new file mode 100644 index 00000000..31b8104d --- /dev/null +++ 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 new file mode 100644 index 00000000..ae60ddbe --- /dev/null +++ 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 deleted file mode 100644 index 5c56ea25..00000000 --- a/docs/resurfemg.helper_functions.helper_functions.rst +++ /dev/null @@ -1,7 +0,0 @@ -resurfemg.helper\_functions.helper\_functions module -==================================================== - -.. automodule:: resurfemg.helper_functions.helper_functions - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/resurfemg.helper_functions.math_operations.rst b/docs/resurfemg.helper_functions.math_operations.rst new file mode 100644 index 00000000..555f008b --- /dev/null +++ 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 index b6ff4be9..dca00c54 100644 --- 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 new file mode 100644 index 00000000..33d89cf5 --- /dev/null +++ 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 new file mode 100644 index 00000000..89815c1e --- /dev/null +++ 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 deleted file mode 100644 index 921fc545..00000000 --- a/docs/resurfemg.pipelines.pipelines.rst +++ /dev/null @@ -1,7 +0,0 @@ -resurfemg.pipelines.pipelines module -==================================== - -.. automodule:: resurfemg.pipelines.pipelines - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/resurfemg.pipelines.processing.rst b/docs/resurfemg.pipelines.processing.rst new file mode 100644 index 00000000..6a6342a1 --- /dev/null +++ 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 index 3a68aac0..ad7068ae 100644 --- 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 new file mode 100644 index 00000000..5211c218 --- /dev/null +++ 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 index 86c64939..5047621d 100644 --- 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 deleted file mode 100644 index ab82ed95..00000000 --- a/docs/resurfemg.visualization.rst +++ /dev/null @@ -1,18 +0,0 @@ -resurfemg.visualization package -=============================== - -Submodules ----------- - -.. toctree:: - :maxdepth: 4 - - resurfemg.visualization.visualization - -Module contents ---------------- - -.. automodule:: resurfemg.visualization - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/resurfemg.visualization.visualization.rst b/docs/resurfemg.visualization.visualization.rst deleted file mode 100644 index b11fe27a..00000000 --- a/docs/resurfemg.visualization.visualization.rst +++ /dev/null @@ -1,7 +0,0 @@ -resurfemg.visualization.visualization module -============================================ - -.. automodule:: resurfemg.visualization.visualization - :members: - :undoc-members: - :show-inheritance: