Restructuring folder. Adding autoapi extension

ami-iit · Jun 29, 2024 · b47d109 · b47d109
1 parent ab220f4
commit b47d109
Showing 29 changed files with 5 additions and 2 deletions.
diff --git a/...urce/_templates/custom-class-template.rst → docs/_templates/custom-class-template.rst b/...urce/_templates/custom-class-template.rst → docs/_templates/custom-class-template.rst
diff --git a/...rce/_templates/custom-module-template.rst → docs/_templates/custom-module-template.rst b/...rce/_templates/custom-module-template.rst → docs/_templates/custom-module-template.rst
diff --git a/docs/source/conf.py → docs/conf.py b/docs/source/conf.py → docs/conf.py
@@ -7,8 +7,6 @@
 import subprocess
 import sys
 
-import adam
-
 sys.path.insert(0, os.path.abspath("."))
 sys.path.insert(0, os.path.abspath("../"))
 sys.path.insert(0, os.path.abspath("../../"))
@@ -42,8 +40,11 @@
     "sphinx_copybutton",
     "myst_parser",
     "sphinx.ext.napoleon",
+    "autoapi.extension",
 ]
 
+autoapi_dirs = ["../src/"]
+
 source_suffix = {
     ".rst": "restructuredtext",
     ".txt": "markdown",

diff --git a/docs/source/index.rst → docs/index.rst b/docs/source/index.rst → docs/index.rst
diff --git a/docs/source/installation.rst → docs/installation.rst b/docs/source/installation.rst → docs/installation.rst
diff --git a/docs/source/modules/adam.core.rst → docs/modules/adam.core.rst b/docs/source/modules/adam.core.rst → docs/modules/adam.core.rst
diff --git a/docs/source/modules/adam.geometry.rst → docs/modules/adam.geometry.rst b/docs/source/modules/adam.geometry.rst → docs/modules/adam.geometry.rst
diff --git a/...urce/modules/adam.model.std_factories.rst → docs/modules/adam.model.std_factories.rst b/...urce/modules/adam.model.std_factories.rst → docs/modules/adam.model.std_factories.rst
diff --git a/...source/modules/adam.parametric.casadi.rst → docs/modules/adam.parametric.casadi.rst b/...source/modules/adam.parametric.casadi.rst → docs/modules/adam.parametric.casadi.rst
diff --git a/docs/source/modules/adam.parametric.jax.rst → docs/modules/adam.parametric.jax.rst b/docs/source/modules/adam.parametric.jax.rst → docs/modules/adam.parametric.jax.rst
diff --git a/...parametric.model.parametric_factories.rst → ...parametric.model.parametric_factories.rst b/...parametric.model.parametric_factories.rst → ...parametric.model.parametric_factories.rst
diff --git a/.../source/modules/adam.parametric.model.rst → docs/modules/adam.parametric.model.rst b/.../source/modules/adam.parametric.model.rst → docs/modules/adam.parametric.model.rst
diff --git a/.../source/modules/adam.parametric.numpy.rst → docs/modules/adam.parametric.numpy.rst b/.../source/modules/adam.parametric.numpy.rst → docs/modules/adam.parametric.numpy.rst
diff --git a/...ource/modules/adam.parametric.pytorch.rst → docs/modules/adam.parametric.pytorch.rst b/...ource/modules/adam.parametric.pytorch.rst → docs/modules/adam.parametric.pytorch.rst
diff --git a/docs/source/modules/adam.parametric.rst → docs/modules/adam.parametric.rst b/docs/source/modules/adam.parametric.rst → docs/modules/adam.parametric.rst
diff --git a/docs/source/modules/casadi.rst → docs/modules/casadi.rst b/docs/source/modules/casadi.rst → docs/modules/casadi.rst
diff --git a/docs/source/modules/index.rst → docs/modules/index.rst b/docs/source/modules/index.rst → docs/modules/index.rst
diff --git a/docs/source/modules/jax.rst → docs/modules/jax.rst b/docs/source/modules/jax.rst → docs/modules/jax.rst
diff --git a/docs/source/modules/model.conversions.rst → docs/modules/model.conversions.rst b/docs/source/modules/model.conversions.rst → docs/modules/model.conversions.rst
diff --git a/docs/source/modules/model.rst → docs/modules/model.rst b/docs/source/modules/model.rst → docs/modules/model.rst
diff --git a/docs/source/modules/numpy.rst → docs/modules/numpy.rst b/docs/source/modules/numpy.rst → docs/modules/numpy.rst
diff --git a/docs/source/modules/pytorch.rst → docs/modules/pytorch.rst b/docs/source/modules/pytorch.rst → docs/modules/pytorch.rst
diff --git a/docs/source/modules/pytorch_batched.rst → docs/modules/pytorch_batched.rst b/docs/source/modules/pytorch_batched.rst → docs/modules/pytorch_batched.rst
diff --git a/docs/source/quickstart/casadi.rst → docs/quickstart/casadi.rst b/docs/source/quickstart/casadi.rst → docs/quickstart/casadi.rst
diff --git a/docs/source/quickstart/index.rst → docs/quickstart/index.rst b/docs/source/quickstart/index.rst → docs/quickstart/index.rst
diff --git a/docs/source/quickstart/jax.rst → docs/quickstart/jax.rst b/docs/source/quickstart/jax.rst → docs/quickstart/jax.rst
diff --git a/docs/source/quickstart/pytorch.rst → docs/quickstart/pytorch.rst b/docs/source/quickstart/pytorch.rst → docs/quickstart/pytorch.rst
diff --git a/docs/source/quickstart/pytorch_batched.rst → docs/quickstart/pytorch_batched.rst b/docs/source/quickstart/pytorch_batched.rst → docs/quickstart/pytorch_batched.rst
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -13,3 +13,5 @@ sphinx-toolbox
 furo
 myst-parser
 graphviz
+mock
+sphinx-autoapi