docs: Move documentation to mkdocstrings hosted on GitHub pages

Signed-off-by: Sietze van Buuren <[email protected]>
swvanbuuren · Aug 19, 2024 · 1426d1a · 1426d1a
1 parent da98f7e
commit 1426d1a
Show file tree

Hide file tree

Showing 35 changed files with 174 additions and 345 deletions.
diff --git a/.github/workflows/docs.yaml b/.github/workflows/docs.yaml
@@ -0,0 +1,31 @@
+name: ci 
+
+on:
+  push:
+    branches:
+      - master 
+
+permissions:
+  contents: write
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Configure Git Credentials
+        run: |
+          git config user.name github-actions[bot]
+          git config user.email 41898282+github-actions[bot]@users.noreply.github.com
+      - uses: actions/setup-python@v5
+        with:
+          python-version: 3.x
+      - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV 
+      - uses: actions/cache@v4
+        with:
+          key: mkdocs-material-${{ env.cache_id }}
+          path: .cache
+          restore-keys: |
+            mkdocs-material-
+      - run: pip install mkdocs-material mkdocstrings[python] pymdown-extensions
+      - run: mkdocs gh-deploy --force
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
diff --git a/doc/Makefile b/doc/Makefile
diff --git a/doc/make.bat b/doc/make.bat
diff --git a/doc/requirements.txt b/doc/requirements.txt
diff --git a/doc/source/conf.py b/doc/source/conf.py
diff --git a/doc/source/examples.rst b/doc/source/examples.rst
diff --git a/doc/source/genindex.rst b/doc/source/genindex.rst
diff --git a/doc/source/getting_started.rst b/doc/source/getting_started.rst
diff --git a/doc/source/index.rst b/doc/source/index.rst
diff --git a/doc/source/installation.rst b/doc/source/installation.rst
diff --git a/doc/source/introduction.rst b/doc/source/introduction.rst
diff --git a/doc/source/reference/axes.rst b/doc/source/reference/axes.rst
diff --git a/doc/source/reference/colors.rst b/doc/source/reference/colors.rst
diff --git a/doc/source/reference/config_options.rst b/doc/source/reference/config_options.rst
diff --git a/doc/source/reference/controllers.rst b/doc/source/reference/controllers.rst
diff --git a/doc/source/reference/descriptors.rst b/doc/source/reference/descriptors.rst
diff --git a/doc/source/reference/index.rst b/doc/source/reference/index.rst
diff --git a/doc/source/reference/ml_functions.rst b/doc/source/reference/ml_functions.rst
diff --git a/doc/source/reference/thread_communicator.rst b/doc/source/reference/thread_communicator.rst
diff --git a/doc/source/reference/windows.rst b/doc/source/reference/windows.rst
diff --git a/doc/source/reference/worker.rst b/doc/source/reference/worker.rst