Merge pull request #25 from AutoDQM/fixing_rtd_to_display_modules

Fixing rtd to display modules
AutoDQM · Jan 20, 2022 · 850ba6a · 850ba6a
2 parents 521c075 + 17fade8
commit 850ba6a
Show file tree

Hide file tree

Showing 16 changed files with 139 additions and 185 deletions.
diff --git a/autodqm_ml/data_formats/histogram.py b/autodqm_ml/data_formats/histogram.py
@@ -52,6 +52,6 @@ def normalize(self):
 
     def clean(self):
         """
-        TODO
+        
         """
         pass
diff --git a/autodqm_ml/data_prep/data_fetcher.py b/autodqm_ml/data_prep/data_fetcher.py
@@ -349,7 +349,6 @@ def write_data(self):
     def write_summary(self):
         """
         Write summary json of configuration.
-        TODO
         """
         return
 
diff --git a/docs/source/algorithms.rst b/docs/source/algorithms.rst
@@ -0,0 +1,53 @@
+algorithms package
+==================
+
+Submodules
+----------
+
+algorithms.anomaly\_detection\_algorithm module
+-----------------------------------------------
+
+.. automodule:: algorithms.anomaly_detection_algorithm
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+algorithms.autoencoder module
+-----------------------------
+
+.. automodule:: algorithms.autoencoder
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+algorithms.ml\_algorithm module
+-------------------------------
+
+.. automodule:: algorithms.ml_algorithm
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+algorithms.pca module
+---------------------
+
+.. automodule:: algorithms.pca
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+algorithms.statistical\_tester module
+-------------------------------------
+
+.. automodule:: algorithms.statistical_tester
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: algorithms
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/autodqm_ml.algorithms.rst b/docs/source/autodqm_ml.algorithms.rst
diff --git a/docs/source/autodqm_ml.data_formats.rst b/docs/source/autodqm_ml.data_formats.rst
diff --git a/docs/source/autodqm_ml.data_prep.rst b/docs/source/autodqm_ml.data_prep.rst
diff --git a/docs/source/autodqm_ml.evaluation.rst b/docs/source/autodqm_ml.evaluation.rst
diff --git a/docs/source/autodqm_ml.plotting.rst b/docs/source/autodqm_ml.plotting.rst
diff --git a/docs/source/autodqm_ml.rst b/docs/source/autodqm_ml.rst
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -12,8 +12,8 @@
 
 import os
 import sys
-#sys.path.insert(0, os.path.abspath('./../../autodqm_ml'))
-sys.path.insert(0, os.path.abspath('.'))
+sys.path.insert(0, os.path.abspath('./../../autodqm_ml'))
+#sys.path.insert(0, os.path.abspath('.'))
 
 # -- Project information -----------------------------------------------------
 
@@ -44,6 +44,9 @@
 # a list of builtin themes.
 #
 html_theme = 'sphinx_rtd_theme'
+import sphinx_rtd_theme
+html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
+
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,

diff --git a/docs/source/data_formats.rst b/docs/source/data_formats.rst
@@ -0,0 +1,21 @@
+data\_formats package
+=====================
+
+Submodules
+----------
+
+data\_formats.histogram module
+------------------------------
+
+.. automodule:: data_formats.histogram
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: data_formats
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/data_prep.rst b/docs/source/data_prep.rst
@@ -0,0 +1,21 @@
+data\_prep package
+==================
+
+Submodules
+----------
+
+data\_prep.data\_fetcher module
+-------------------------------
+
+.. automodule:: data_prep.data_fetcher
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: data_prep
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/evaluation.rst b/docs/source/evaluation.rst
@@ -0,0 +1,10 @@
+evaluation package
+==================
+
+Module contents
+---------------
+
+.. automodule:: evaluation
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -10,11 +10,11 @@ Welcome to autodqm_ml's documentation!
    :maxdepth: 3
    :caption: Contents:
 
-   autodqm_ml.algorithms
-   autodqm_ml.data_formats
-   autodqm_ml.data_prep
-   autodqm_ml.evaluation
-   autodqm_ml.plotting
+   algorithms
+   data_formats
+   data_prep
+   evaluation
+   plotting
    modules
 
 Indices and tables

diff --git a/docs/source/modules.rst b/docs/source/modules.rst
@@ -1,7 +1,7 @@
-autodqm_ml
+algorithms
 ==========
 
 .. toctree::
    :maxdepth: 4
 
-   autodqm_ml
+   algorithms
diff --git a/docs/source/plotting.rst b/docs/source/plotting.rst
@@ -0,0 +1,21 @@
+plotting package
+================
+
+Submodules
+----------
+
+plotting.plot\_tools module
+---------------------------
+
+.. automodule:: plotting.plot_tools
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: plotting
+   :members:
+   :undoc-members:
+   :show-inheritance:
-Original file line number
+Diff line change
@@ Expand Up / @@ -52,6 +52,6 @@ def normalize(self): @@
         def clean(self):
             """
-            TODO
             """
             pass