Files to generate API doc

CosmoStat · Oct 16, 2023 · 8d2d56b · 8d2d56b
1 parent 9815241
commit 8d2d56b
Show file tree

Hide file tree

Showing 32 changed files with 327 additions and 10 deletions.
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -2,27 +2,41 @@
 #
 # For the full list of built-in configuration values, see the documentation:
 # https://www.sphinx-doc.org/en/master/usage/configuration.html
+import sys
+import os
+
+sys.path.insert(0, os.path.abspath("src/wf_psf"))
 
 # -- Project information -----------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
 
-project = 'wf-psf'
-copyright = '2023, Tobias Liaudat, Jennifer Pollack, Sam Farrens'
-author = 'Tobias Liaudat, Jennifer Pollack, Sam Farrens'
-release = '1.0.0'
+project = "wf-psf"
+copyright = "2023, Tobias Liaudat, Jennifer Pollack, Sam Farrens"
+author = "Tobias Liaudat, Jennifer Pollack, Sam Farrens"
+release = "1.0.0"
 
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
 
-extensions = []
+extensions = [
+    "sphinx.ext.autodoc",
+    "sphinx.ext.doctest",
+    "sphinx.ext.intersphinx",
+    "sphinx.ext.napoleon",
+    "sphinx.ext.viewcode",
+    "numpydoc",
+]
 
-templates_path = ['_templates']
+templates_path = ["_templates"]
 exclude_patterns = []
-
+intersphinx_mapping = {
+    "python": ("http://docs.python.org/3", None),
+    "numpy": ("https://numpy.org/doc/stable/", None),
+}
 
 
 # -- Options for HTML output -------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
 
-html_theme = 'alabaster'
-html_static_path = ['_static']
+html_theme = "sphinx_rtd_theme"
+html_static_path = ["_static"]
diff --git a/docs/source/modules.rst b/docs/source/modules.rst
@@ -1,6 +1,7 @@
-wf-psf
+wf_psf
 ======
 
 .. toctree::
    :maxdepth: 4
 
+   wf_psf
diff --git a/docs/source/wf_psf.data.rst b/docs/source/wf_psf.data.rst
@@ -0,0 +1,15 @@
+wf\_psf.data package
+====================
+
+.. automodule:: wf_psf.data
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Submodules
+----------
+
+.. toctree::
+   :maxdepth: 4
+
+   wf_psf.data.training_preprocessing
diff --git a/docs/source/wf_psf.data.training_preprocessing.rst b/docs/source/wf_psf.data.training_preprocessing.rst
@@ -0,0 +1,7 @@
+wf\_psf.data.training\_preprocessing module
+===========================================
+
+.. automodule:: wf_psf.data.training_preprocessing
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/wf_psf.info.rst b/docs/source/wf_psf.info.rst
@@ -0,0 +1,7 @@
+wf\_psf.info module
+===================
+
+.. automodule:: wf_psf.info
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/wf_psf.metrics.metrics.rst b/docs/source/wf_psf.metrics.metrics.rst
@@ -0,0 +1,7 @@
+wf\_psf.metrics.metrics module
+==============================
+
+.. automodule:: wf_psf.metrics.metrics
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/wf_psf.metrics.metrics_interface.rst b/docs/source/wf_psf.metrics.metrics_interface.rst
@@ -0,0 +1,7 @@
+wf\_psf.metrics.metrics\_interface module
+=========================================
+
+.. automodule:: wf_psf.metrics.metrics_interface
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/wf_psf.metrics.rst b/docs/source/wf_psf.metrics.rst
@@ -0,0 +1,16 @@
+wf\_psf.metrics package
+=======================
+
+.. automodule:: wf_psf.metrics
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Submodules
+----------
+
+.. toctree::
+   :maxdepth: 4
+
+   wf_psf.metrics.metrics
+   wf_psf.metrics.metrics_interface
diff --git a/docs/source/wf_psf.plotting.plot_optimisation_metrics.rst b/docs/source/wf_psf.plotting.plot_optimisation_metrics.rst
@@ -0,0 +1,7 @@
+wf\_psf.plotting.plot\_optimisation\_metrics module
+===================================================
+
+.. automodule:: wf_psf.plotting.plot_optimisation_metrics
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/wf_psf.plotting.plots_interface.rst b/docs/source/wf_psf.plotting.plots_interface.rst
@@ -0,0 +1,7 @@
+wf\_psf.plotting.plots\_interface module
+========================================
+
+.. automodule:: wf_psf.plotting.plots_interface
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/wf_psf.plotting.rst b/docs/source/wf_psf.plotting.rst
@@ -0,0 +1,16 @@
+wf\_psf.plotting package
+========================
+
+.. automodule:: wf_psf.plotting
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Submodules
+----------
+
+.. toctree::
+   :maxdepth: 4
+
+   wf_psf.plotting.plot_optimisation_metrics
+   wf_psf.plotting.plots_interface
diff --git a/docs/source/wf_psf.psf_models.psf_model_parametric.rst b/docs/source/wf_psf.psf_models.psf_model_parametric.rst
@@ -0,0 +1,7 @@
+wf\_psf.psf\_models.psf\_model\_parametric module
+=================================================
+
+.. automodule:: wf_psf.psf_models.psf_model_parametric
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/wf_psf.psf_models.psf_model_semiparametric.rst b/docs/source/wf_psf.psf_models.psf_model_semiparametric.rst
@@ -0,0 +1,7 @@
+wf\_psf.psf\_models.psf\_model\_semiparametric module
+=====================================================
+
+.. automodule:: wf_psf.psf_models.psf_model_semiparametric
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/wf_psf.psf_models.psf_models.rst b/docs/source/wf_psf.psf_models.psf_models.rst
@@ -0,0 +1,7 @@
+wf\_psf.psf\_models.psf\_models module
+======================================
+
+.. automodule:: wf_psf.psf_models.psf_models
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/wf_psf.psf_models.rst b/docs/source/wf_psf.psf_models.rst
@@ -0,0 +1,21 @@
+wf\_psf.psf\_models package
+===========================
+
+.. automodule:: wf_psf.psf_models
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Submodules
+----------
+
+.. toctree::
+   :maxdepth: 4
+
+   wf_psf.psf_models.psf_model_parametric
+   wf_psf.psf_models.psf_model_semiparametric
+   wf_psf.psf_models.psf_models
+   wf_psf.psf_models.tf_layers
+   wf_psf.psf_models.tf_modules
+   wf_psf.psf_models.tf_psf_field
+   wf_psf.psf_models.zernikes
diff --git a/docs/source/wf_psf.psf_models.tf_layers.rst b/docs/source/wf_psf.psf_models.tf_layers.rst
@@ -0,0 +1,7 @@
+wf\_psf.psf\_models.tf\_layers module
+=====================================
+
+.. automodule:: wf_psf.psf_models.tf_layers
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/wf_psf.psf_models.tf_modules.rst b/docs/source/wf_psf.psf_models.tf_modules.rst
@@ -0,0 +1,7 @@
+wf\_psf.psf\_models.tf\_modules module
+======================================
+
+.. automodule:: wf_psf.psf_models.tf_modules
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/wf_psf.psf_models.tf_psf_field.rst b/docs/source/wf_psf.psf_models.tf_psf_field.rst
@@ -0,0 +1,7 @@
+wf\_psf.psf\_models.tf\_psf\_field module
+=========================================
+
+.. automodule:: wf_psf.psf_models.tf_psf_field
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/wf_psf.psf_models.zernikes.rst b/docs/source/wf_psf.psf_models.zernikes.rst
@@ -0,0 +1,7 @@
+wf\_psf.psf\_models.zernikes module
+===================================
+
+.. automodule:: wf_psf.psf_models.zernikes
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/wf_psf.rst b/docs/source/wf_psf.rst
@@ -0,0 +1,30 @@
+wf\_psf package
+===============
+
+.. automodule:: wf_psf
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   wf_psf.data
+   wf_psf.metrics
+   wf_psf.plotting
+   wf_psf.psf_models
+   wf_psf.sims
+   wf_psf.training
+   wf_psf.utils
+
+Submodules
+----------
+
+.. toctree::
+   :maxdepth: 4
+
+   wf_psf.info
+   wf_psf.run
diff --git a/docs/source/wf_psf.run.rst b/docs/source/wf_psf.run.rst
@@ -0,0 +1,7 @@
+wf\_psf.run module
+==================
+
+.. automodule:: wf_psf.run
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/wf_psf.sims.SimPSFToolkit.rst b/docs/source/wf_psf.sims.SimPSFToolkit.rst
@@ -0,0 +1,7 @@
+wf\_psf.sims.SimPSFToolkit module
+=================================
+
+.. automodule:: wf_psf.sims.SimPSFToolkit
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/wf_psf.sims.rst b/docs/source/wf_psf.sims.rst
@@ -0,0 +1,15 @@
+wf\_psf.sims package
+====================
+
+.. automodule:: wf_psf.sims
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Submodules
+----------
+
+.. toctree::
+   :maxdepth: 4
+
+   wf_psf.sims.SimPSFToolkit
diff --git a/docs/source/wf_psf.training.rst b/docs/source/wf_psf.training.rst
@@ -0,0 +1,16 @@
+wf\_psf.training package
+========================
+
+.. automodule:: wf_psf.training
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Submodules
+----------
+
+.. toctree::
+   :maxdepth: 4
+
+   wf_psf.training.train
+   wf_psf.training.train_utils
diff --git a/docs/source/wf_psf.training.train.rst b/docs/source/wf_psf.training.train.rst
@@ -0,0 +1,7 @@
+wf\_psf.training.train module
+=============================
+
+.. automodule:: wf_psf.training.train
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/wf_psf.training.train_utils.rst b/docs/source/wf_psf.training.train_utils.rst
@@ -0,0 +1,7 @@
+wf\_psf.training.train\_utils module
+====================================
+
+.. automodule:: wf_psf.training.train_utils
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/wf_psf.utils.configs_handler.rst b/docs/source/wf_psf.utils.configs_handler.rst
@@ -0,0 +1,7 @@
+wf\_psf.utils.configs\_handler module
+=====================================
+
+.. automodule:: wf_psf.utils.configs_handler
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/wf_psf.utils.graph_utils.rst b/docs/source/wf_psf.utils.graph_utils.rst
@@ -0,0 +1,7 @@
+wf\_psf.utils.graph\_utils module
+=================================
+
+.. automodule:: wf_psf.utils.graph_utils
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/wf_psf.utils.io.rst b/docs/source/wf_psf.utils.io.rst
@@ -0,0 +1,7 @@
+wf\_psf.utils.io module
+=======================
+
+.. automodule:: wf_psf.utils.io
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/wf_psf.utils.read_config.rst b/docs/source/wf_psf.utils.read_config.rst
@@ -0,0 +1,7 @@
+wf\_psf.utils.read\_config module
+=================================
+
+.. automodule:: wf_psf.utils.read_config
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/wf_psf.utils.rst b/docs/source/wf_psf.utils.rst
@@ -0,0 +1,19 @@
+wf\_psf.utils package
+=====================
+
+.. automodule:: wf_psf.utils
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Submodules
+----------
+
+.. toctree::
+   :maxdepth: 4
+
+   wf_psf.utils.configs_handler
+   wf_psf.utils.graph_utils
+   wf_psf.utils.io
+   wf_psf.utils.read_config
+   wf_psf.utils.utils
diff --git a/docs/source/wf_psf.utils.utils.rst b/docs/source/wf_psf.utils.utils.rst
@@ -0,0 +1,7 @@
+wf\_psf.utils.utils module
+==========================
+
+.. automodule:: wf_psf.utils.utils
+   :members:
+   :undoc-members:
+   :show-inheritance: