include API autodoc (#157)

* include API autodoc * lint
ML4GW · Oct 15, 2024 · f6040d8 · f6040d8
1 parent 3f097bb
commit f6040d8
Show file tree

Hide file tree

Showing 12 changed files with 543 additions and 432 deletions.
diff --git a/.gitignore b/.gitignore
@@ -4,3 +4,4 @@
 **/*.env
 **/*.sif
 **/*.hdf5
+_build
diff --git a/docs/amplfi.data.rst b/docs/amplfi.data.rst
@@ -0,0 +1,6 @@
+amplfi.data module
+==================
+
+.. automodule:: amplfi.data.base
+.. automodule:: amplfi.data.paths
+.. automodule:: amplfi.data.tasks
diff --git a/docs/amplfi.rst b/docs/amplfi.rst
@@ -0,0 +1,11 @@
+API Reference
+=============
+
+.. automodule:: amplfi
+
+.. toctree::
+    :maxdepth: 2
+
+    amplfi.data
+    amplfi.train
+    amplfi.tune
diff --git a/docs/amplfi.train.architectures.rst b/docs/amplfi.train.architectures.rst
@@ -0,0 +1,6 @@
+amplfi.train.architectures module
+=================================
+
+.. automodule:: amplfi.train.architectures.flows.base
+.. automodule:: amplfi.train.architectures.flows.coupling
+.. automodule:: amplfi.train.architectures.flows.iaf
diff --git a/docs/amplfi.train.cli.rst b/docs/amplfi.train.cli.rst
@@ -0,0 +1,6 @@
+amplfi.train.cli module
+-----------------------
+
+.. automodule:: amplfi.train.cli.base
+.. automodule:: amplfi.train.cli.flow
+.. automodule:: amplfi.train.cli.similarity
diff --git a/docs/amplfi.train.configs.rst b/docs/amplfi.train.configs.rst
@@ -0,0 +1,5 @@
+amplfi.train.configs module
+===========================
+
+.. automodule:: amplfi.train.configs.flow
+.. automodule:: amplfi.train.configs.similarity
diff --git a/docs/amplfi.train.models.rst b/docs/amplfi.train.models.rst
@@ -0,0 +1,5 @@
+amplfi.train.models module
+==========================
+
+.. automodule:: amplfi.train.models.flow
+.. automodule:: amplfi.train.models.similarity
diff --git a/docs/amplfi.train.rst b/docs/amplfi.train.rst
@@ -0,0 +1,20 @@
+amplfi.train module
+===================
+
+.. automodule:: amplfi.train.augmentations
+.. automodule:: amplfi.train.callbacks
+.. automodule:: amplfi.train.losses
+.. automodule:: amplfi.train.priors
+
+
+.. toctree::
+    amplfi.train.architectures
+
+.. toctree::
+    amplfi.train.models
+
+.. toctree::
+    amplfi.train.cli
+
+.. toctree::
+    amplfi.train.configs
diff --git a/docs/amplfi.tune.rst b/docs/amplfi.tune.rst
@@ -0,0 +1,4 @@
+amplfi.tune module
+==================
+
+.. automodule:: amplfi.tune.tune
diff --git a/docs/conf.py b/docs/conf.py
@@ -10,18 +10,21 @@
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 #
-import os
 import sys
+from importlib.metadata import distribution
+from pathlib import Path
 
-sys.path.insert(0, os.path.abspath("../"))
+parent_path = str(Path(__file__).parents[1])
+sys.path.insert(0, parent_path)
 
 
 # -- Project information -----------------------------------------------------
+dist = distribution("amplfi")
 
-project = "amplfi"
-copyright = "2024, Ethan Marx, Deep Chatterjee"
-author = "Ethan Marx, Deep Chatterjee"
-
+project = dist.metadata["Name"]
+author = dist.metadata["Author"]
+copyright = f"2024, {author}"
+release = dist.metadata["Version"]
 
 # -- General configuration ---------------------------------------------------
 
@@ -31,6 +34,7 @@
 extensions = [
     "sphinx.ext.autodoc",
     "sphinx.ext.napoleon",
+    "sphinx.ext.viewcode",
     "sphinx_tabs.tabs",
     "sphinx_autodoc_typehints",
     "sphinx.ext.githubpages",
@@ -83,3 +87,14 @@
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
 html_static_path = ["_static"]
+
+autodoc_default_options = {
+    "members": None,
+    "undoc-members": None,
+    "show-inheritance": None,
+}
+autodoc_inherit_docstrings = False
+autodoc_member_order = "bysource"
+autosummary_generate = True
+
+modindex_common_prefix = ["amplfi."]
diff --git a/docs/index.md b/docs/index.md
@@ -12,6 +12,7 @@ Framework for performing rapid (~ 1s) parameter estimation of gravitational wave
    Installation <installation>
    First pipeline <first_pipeline>
    Contributing <contributing>
+   amplfi
 
 .. toctree::
    :caption: Advanced

diff --git a/poetry.lock b/poetry.lock