From ed379fab262ea5cfa54177aa97c55b0d88acf4a9 Mon Sep 17 00:00:00 2001
From: chrwm <christoph.muschner@rl-institut.de>
Date: Thu, 7 Mar 2024 16:53:30 +0100
Subject: [PATCH] Add deploy automation

---
 .github/workflows/build_documentation.yml | 31 +++++++++++++++++++++++
 built_docs_for_gh_pages/README.md         |  1 +
 requirements.txt                          |  1 +
 3 files changed, 33 insertions(+)
 create mode 100644 .github/workflows/build_documentation.yml
 create mode 100644 built_docs_for_gh_pages/README.md

diff --git a/.github/workflows/build_documentation.yml b/.github/workflows/build_documentation.yml
new file mode 100644
index 0000000..0311861
--- /dev/null
+++ b/.github/workflows/build_documentation.yml
@@ -0,0 +1,31 @@
+name: MkDocs Build and Deploy
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout Repository
+      uses: actions/checkout@v3
+
+    - name: Set up Python
+      uses: actions/setup-python@v4
+      with:
+        python-version: 3.x
+
+    - name: Install Dependencies
+      run: pip install --upgrade -r requirements.txt
+
+    - name: Build MkDocs
+      run: mkdocs build
+
+    - name: Archive MkDocs Build
+      uses: actions/upload-artifact@v2
+      with:
+        name: mkdocs-artifacts
+        path: ./built_docs_for_gh_pages  # Change this to your MkDocs build directory
diff --git a/built_docs_for_gh_pages/README.md b/built_docs_for_gh_pages/README.md
new file mode 100644
index 0000000..79892c6
--- /dev/null
+++ b/built_docs_for_gh_pages/README.md
@@ -0,0 +1 @@
+This directory holds the deployed docs for GitHub pages
\ No newline at end of file
diff --git a/requirements.txt b/requirements.txt
index ddc9fc3..8be76f4 100644
--- a/requirements.txt
+++ b/requirements.txt
@@ -1,2 +1,3 @@
+mkdocs-material==9.5.13
 mkdocs==1.3.0
 pymdown-extensions==9.6
\ No newline at end of file