Add notebook to documentation

Author: psomhorst

.github/workflows/test_build_documentation.yml

@@ -28,7 +28,9 @@ jobs:
           extract-data: false
           python-version: "3.10"
       - name: Build documentation
-        run: mkdocs build
+        run: |
+          ln -s notebooks docs/examples/notebooks
+          mkdocs build
       - name: Deploy documentation
         if: github.ref == 'refs/heads/main'
         run: mkdocs gh-deploy

docs/examples/.gitkeep

@@ -46,7 +46,8 @@ nav:
   - Home: index.md
   - Getting started:
       - installation.md
-      - basic_example.md
+      - Example Notebooks:
+        - examples/notebooks/test_ratedetection.ipynb
   - API Documentation:
       - api/loading.md
       - Data Containers:
@@ -115,6 +116,7 @@ plugins:
       glob:
         - __pycache__/*
   - autorefs
+  - mkdocs-jupyter
   - mkdocstrings:
       handlers:
         python: