From 02a04754cb63ecfdbb3476530817e9ed71f07c50 Mon Sep 17 00:00:00 2001
From: Adam Amer <136176500+adamamer20@users.noreply.github.com>
Date: Tue, 20 Aug 2024 16:45:23 +0200
Subject: [PATCH] automatic gh action for publishing mkdocs

---
 .github/workflows/docs-gh-pages.yml | 21 +++++++++++++++++++++
 docs/requirements.txt               |  3 +++
 2 files changed, 24 insertions(+)
 create mode 100644 .github/workflows/docs-gh-pages.yml
 create mode 100644 docs/requirements.txt

diff --git a/.github/workflows/docs-gh-pages.yml b/.github/workflows/docs-gh-pages.yml
new file mode 100644
index 00000000..cbebd706
--- /dev/null
+++ b/.github/workflows/docs-gh-pages.yml
@@ -0,0 +1,21 @@
+name: Publish docs via GitHub Pages
+on:
+  push:
+    branches:
+      - main
+      - material-for-mkdocs
+
+jobs:
+  build:
+    name: Deploy docs
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout main
+        uses: actions/checkout@v2
+
+      - name: Deploy docs
+        uses: mhausenblas/mkdocs-deploy-gh-pages@master
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          CONFIG_FILE: docs/mkdocs.yml
+          REQUIREMENTS: docs/requirements.txt
\ No newline at end of file
diff --git a/docs/requirements.txt b/docs/requirements.txt
new file mode 100644
index 00000000..f8dbd67e
--- /dev/null
+++ b/docs/requirements.txt
@@ -0,0 +1,3 @@
+mkdocs-jupyter
+mkdocs-git-revision-date-localized-plugin
+mkdocs-minify-plugin
\ No newline at end of file