Merge pull request #6 from naturerobots/feature/add-docs-build-on-pr

add workflow that builds docs on PR

Author: Cakem1x

.github/workflows/mkdocs_build.yml

@@ -0,0 +1,27 @@
+name: Build Documentation using MkDocs
+
+# Controls when the action will run. Triggers the workflow on push or pull request
+# events but only for the master branch
+on:
+  pull_request:
+    branches: [main]
+jobs:
+  build:
+    name: Build Documentation
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v4
+      - 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 -r requirements.txt
+      - name: Build documentation
+        run: mkdocs build --strict

docs/run.md

@@ -0,0 +1,3 @@
+
+
+TODO

mkdocs.yml

@@ -36,6 +36,7 @@ nav:
   - Home:
     - Overview: index.md
     - Installation: installation.md
+    - Run: run.md
   - Theory:
     - Overview: theory/index.md
     - Why Meshes: theory/mesh_maps.md