Finish build setup

Author: stes

build_docs.sh

@@ -5,7 +5,7 @@ This directory contains the documentation for CEBRA.
 To build the docs, head to *the root folder of the repository* and run:
 
 ```bash
-./build_docs.sh
+./tools/build_docs.sh
 ```
 
 This will build the docker container in [Dockerfile](Dockerfile) and run the `make docs` command from the root repo.

docs/README.md

@@ -131,7 +131,7 @@ def get_years(start_year=2021):
 # 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"
+    "*/cebra-figures/*.rst", "*/demo_notebooks/README.rst",
     "demo_notebooks/README.rst"
 ]
 

docs/source/conf.py

@@ -1,79 +1,17 @@
 #!/bin/bash
-# Locally build the documentation and display it in a webserver.
 
-set -xe
-
-git_checkout_or_pull() {
-    local repo=$1
-    local target_dir=$2
-    # TODO(stes): theoretically we could also auto-update the repo,
-    # I commented this out for now to avoid interference with local
-    # dev/changes
-    #if [ -d "$target_dir" ]; then
-    #    cd "$target_dir"
-    #    git pull --ff-only origin main
-    #    cd -
-    #else
-    if [ ! -d "$target_dir" ]; then
-        git clone "$repo" "$target_dir"
-    fi
-}
-
-checkout_cebra_figures() {
-    git_checkout_or_pull [email protected]:AdaptiveMotorControlLab/cebra-figures.git docs/source/cebra-figures
-}
-
-checkout_assets() {
-    git_checkout_or_pull [email protected]:AdaptiveMotorControlLab/cebra-assets.git assets
-}
-
-checkout_cebra_demos() {
-    git_checkout_or_pull [email protected]:AdaptiveMotorControlLab/cebra-demos.git docs/source/demo_notebooks
-}
-
-setup_python() {
-    python -m pip install --upgrade pip setuptools wheel
-    sudo apt-get install -y pandoc
-    pip install torch --extra-index-url=https://download.pytorch.org/whl/cpu
-    pip install '.[docs]'
-}
-
-build_docs() {
-    cp -r assets/* .
-    export SPHINXOPTS="-W --keep-going -n"
-    (cd docs && PYTHONPATH=.. make page)
-}
-
-serve() {
-    python -m http.server 8080 --b 0.0.0.0 -d docs/build/html
-}
-
-main() {
-    build_docs
-    serve
-}
-
-if [[ "$1" == "--build" ]]; then
-    main
-fi
-
-docker build -t cebra-docs -f - . << "EOF"
-FROM python:3.9
-RUN python -m pip install --upgrade pip setuptools wheel \
-    && apt-get update -y && apt-get install -y pandoc git
-RUN pip install torch --extra-index-url=https://download.pytorch.org/whl/cpu
-COPY dist/cebra-0.5.0-py3-none-any.whl .
-RUN pip install 'cebra-0.5.0-py3-none-any.whl[docs]'
-EOF
-
-checkout_cebra_figures
-checkout_assets
-checkout_cebra_demos
-
-docker run \
-    -p 127.0.0.1:8080:8080 \
-    -u $(id -u):$(id -g) \
-    -v .:/app -w /app \
-    --tmpfs /.config --tmpfs /.cache \
-    -it cebra-docs \
-    ./tools/build_docs.sh --build
+docker build -t cebra-docs -f docs/Dockerfile .
+
+docker run -u $(id -u):$(id -g) \
+  -p 127.0.0.1:8000:8000 \
+  -v $(pwd):/app \
+  -v /tmp/.cache/pip:/.cache/pip \
+  -v /tmp/.cache/sphinx:/.cache/sphinx \
+  -v /tmp/.cache/matplotlib:/.cache/matplotlib \
+  -v /tmp/.cache/fontconfig:/.cache/fontconfig \
+  -e MPLCONFIGDIR=/tmp/.cache/matplotlib \
+  -w /app \
+  --env HOST=0.0.0.0 \
+  --env PORT=8000 \
+  -it cebra-docs \
+  make docs