update docs

Author: stes

.github/workflows/docs.yml

@@ -55,7 +55,11 @@ jobs:
         with:
           repository: AdaptiveMotorControlLab/cebra-demos
           path: docs/source/demo_notebooks
-          ref: main
+          # NOTE(stes): This is a temporary branch to add the xCEBRA demo notebooks
+          # to the docs. Once the notebooks are merged into main, we can remove this
+          # branch and change the ref to main.
+          # ref: main
+          ref: stes/add-xcebra
 
       - name: Set up Python ${{ matrix.python-version }}
         uses: actions/setup-python@v5

docs/Makefile

@@ -3,7 +3,7 @@
 
 # You can set these variables from the command line, and also
 # from the environment for the first two.
-SPHINXOPTS    ?=
+SPHINXOPTS    ?= -W --keep-going -n
 SPHINXBUILD   ?= sphinx-autobuild
 SOURCEDIR     = source
 BUILDDIR      = build
@@ -33,10 +33,10 @@ clean:
 # Checkout the source repository for CEBRA figures. Note that this requires SSH access
 # and might prompt you for an SSH key.
 source/cebra-figures:
-	git clone --depth 1 [email protected]:AdaptiveMotorControlLab/cebra-figures.git source/cebra-figures
+	cd $(dir $(realpath $(firstword $(MAKEFILE_LIST)))) && git clone --depth 1 [email protected]:AdaptiveMotorControlLab/cebra-figures.git source/cebra-figures
 
 source/demo_notebooks:
-	git clone --depth 1 [email protected]:AdaptiveMotorControlLab/cebra-demos.git source/demo_notebooks
+	cd $(dir $(realpath $(firstword $(MAKEFILE_LIST)))) && git clone --depth 1 [email protected]:AdaptiveMotorControlLab/cebra-demos.git source/demo_notebooks
 
 # Update the figures. Note that this might prompt you for an SSH key
 figures: source/cebra-figures
@@ -46,7 +46,7 @@ demos: source/demo_notebooks
 	cd source/demo_notebooks &&	git pull --ff-only origin main
 
 source/assets:
-	git clone --depth 1 [email protected]:AdaptiveMotorControlLab/cebra-assets.git source/assets
+	cd $(dir $(realpath $(firstword $(MAKEFILE_LIST)))) && git clone --depth 1 [email protected]:AdaptiveMotorControlLab/cebra-assets.git source/assets
 
 assets: source/assets
 	cd source/assets && git pull --ff-only origin main

docs/source/api.rst

@@ -38,6 +38,7 @@ these components in other contexts and research code bases.
    api/pytorch/distributions
    api/pytorch/models
    api/pytorch/helpers
+   api/pytorch/attribution
 
 .. toctree::
    :hidden:

docs/source/api/pytorch/attribution.rst

@@ -0,0 +1,7 @@
+===================
+Attribution Methods
+===================
+
+.. automodule:: cebra.attribution
+   :members:
+   :show-inheritance:

docs/source/conf.py

@@ -119,7 +119,8 @@ def get_years(start_year=2021):
 
 autodoc_member_order = "bysource"
 autodoc_mock_imports = [
-    "torch", "nlb_tools", "tqdm", "h5py", "pandas", "matplotlib", "plotly"
+    "torch", "nlb_tools", "tqdm", "h5py", "pandas", "matplotlib", "plotly",
+    "cvxpy", "captum"
 ]
 # autodoc_typehints = "none"
 
@@ -130,9 +131,18 @@ def get_years(start_year=2021):
 # directories to ignore when looking for source files.
 # This pattern also affects html_static_path and html_extra_path.
 exclude_patterns = [
-    "**/todo", "**/src", "cebra-figures/figures.rst", "cebra-figures/*.rst",
-    "*/cebra-figures/*.rst", "*/demo_notebooks/README.rst",
-    "demo_notebooks/README.rst"
+    "**/todo",
+    "**/src",
+    "cebra-figures/figures.rst",
+    "cebra-figures/*.rst",
+    "*/cebra-figures/*.rst",
+    "*/demo_notebooks/README.rst",
+    "demo_notebooks/README.rst",
+    # TODO(stes): Remove this from the assets repo, then remove here
+    "_static/figures_usage.ipynb",
+    "*/_static/figures_usage.ipynb",
+    "assets/**/*.ipynb",
+    "*/assets/**/*.ipynb"
 ]
 
 # -- Options for HTML output -------------------------------------------------