update docs

Author: MichaelSchuldes

.github/workflows/docs.yml

@@ -0,0 +1,28 @@
+name: docs 
+on:
+  push:
+    branches:
+      - mkdocs
+      - main
+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
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+        with:
+            # Install a specific version of uv.
+            enable-cache: true
+            version: "0.6.12"
+            python-version: 3.12
+
+      - name: Install the project
+        run: uv sync --all-extras --dev
+      - run: mkdocs gh-deploy --force

docs/README.md

@@ -8,7 +8,7 @@
 `uv pip install -e .[test]`
 2. Create the documentation and start webserver serving them
 ```
-mkdocs server -a localhost:5555
+mkdocs serve -a localhost:5555
 ```
 or create the html pages with
 ```
@@ -18,3 +18,4 @@ mkdocs build -d docs_build
 ## Upload documentation to github-pages
 
 [Guide](https://www.mkdocs.org/user-guide/deploying-your-docs/)
+https://squidfunk.github.io/mkdocs-material/publishing-your-site/#with-github-actions

pyproject.toml

@@ -88,9 +88,9 @@ zero = true
 addopts = "--nbval --codeblocks --cov=omega_prime --cov-report=xml --cov-report=html --cov-report=term-missing"
 testpaths = [
     "tests",
-    "tutorial.ipynb",
-    "tutorial_locator.ipynb",
-    "tutorial_metrics.ipynb",
+    "docs/notebooks/tutorial.ipynb",
+    "docs/notebooks/tutorial_locator.ipynb",
+    "docs/notebooks/tutorial_metrics.ipynb",
     "README.md"
 ]
 log_cli = true