Create build-mkdocs.yaml

.github/workflows/build-mkdocs.yaml

@@ -0,0 +1,47 @@
+###########################################################################################
+# Build the documentation using mkdocs
+# This will update the gh-pages branch which in return triggers the pages-build-deployment
+# Action (provided by Github, not editable)
+# That action will publish it to https://jomjol.github.io/AI-on-the-edge-device-docs
+###########################################################################################
+
+name: Build Documentation
+
+on: 
+  push:
+    branches:
+    - main
+
+jobs:
+  build-documentation:
+    runs-on: ubuntu-latest
+
+    # Steps represent a sequence of tasks that will be executed as part of the job
+    steps:
+      - name: Cache PIP
+        uses: actions/cache@v3
+        with:
+          path: ~/.cache/pip
+          key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
+          restore-keys: |
+            ${{ runner.os }}-pip-
+          
+      # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+      - uses: actions/setup-python@v4
+      - run: |
+          pip install --upgrade pip && pip install mkdocs mkdocs-gen-files mkdocs-awesome-pages-plugin mkdocs-material mkdocs-mermaid2-plugin
+          git config user.name 'github-actions[bot]'
+          git config user.email 'github-actions[bot]@users.noreply.github.com'
+          
+      - name: Generate Parameter Page
+        run: |
+          cd param-docs
+          python generate-template-param-doc-pages.py # Creates a templated page for each parameter which does not yet have a page
+          tree parameter-pages
+          python concat-parameter-pages.py
+        
+      - name: Store Documentation in the gh-pages branch so it gets pushed to the website
+        run: mkdocs gh-deploy