Separate docs into different modules. Add make.py script to build the…

… docs

.github/workflows/docs.yml

@@ -24,7 +24,7 @@ jobs:
           poetry run python -m pip install --upgrade pip
           poetry run pip install torch torchvision torchaudio --index-url https://download.pytorch.org/whl/cpu
           poetry run pip install lightning
-      - run: poetry run pdoc ./shimmer/* -o docs/api/ --docformat=google
+      - run: poetry run python ./docs/make.py
       - uses: actions/upload-pages-artifact@v3
         with:
           path: docs/api/

docs/make.py

@@ -0,0 +1,20 @@
+from pathlib import Path
+
+import pdoc
+
+modules = [
+    "shimmer.types",
+    "shimmer.modules.global_workspace",
+    "shimmer.modules.domain",
+    "shimmer.modules.gw_module",
+    "shimmer.modules.losses",
+    "shimmer.modules.contrastive_loss",
+    "shimmer.dataset",
+    "shimmer.modules.vae",
+]
+
+here = Path(__file__).parent
+
+if __name__ == "__main__":
+    pdoc.render.configure(docformat="google")
+    pdoc.pdoc(*modules, output_directory=here / "api")

pyproject.toml

@@ -52,7 +52,7 @@ target-version = "py311"
 extend-exclude = [
     "__pycache__",
     ".mypy_cache",
-    "docs",
+    "docs/api",
     ".github",
 ]