From 43af1e46efec3eac2168079055e628e445a56001 Mon Sep 17 00:00:00 2001
From: Toni Harzendorf <toni.harzendorf@ufz.de>
Date: Mon, 30 Dec 2024 18:30:53 +0100
Subject: [PATCH 1/2] mkdocs: set the base_path for snippets relative to
 config_dir

---
 mkdocs.yml | 1 +
 1 file changed, 1 insertion(+)

diff --git a/mkdocs.yml b/mkdocs.yml
index 31e911d3..723b429f 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -65,6 +65,7 @@ markdown_extensions:
   - admonition
   - pymdownx.snippets:
       check_paths: true
+      base_path: !relative $config_dir
   - pymdownx.highlight:
       anchor_linenums: true
       line_spans: __span

From 0c2566e3730539aa88cf128bf4c2fd39b0cb9ec9 Mon Sep 17 00:00:00 2001
From: Toni Harzendorf <toni.harzendorf@ufz.de>
Date: Mon, 30 Dec 2024 18:31:28 +0100
Subject: [PATCH 2/2] mkdocs: add script to deploy docs to pyslurm.github.io
 git dir

---
 scripts/deploy-docs.sh | 50 ++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 50 insertions(+)
 create mode 100755 scripts/deploy-docs.sh

diff --git a/scripts/deploy-docs.sh b/scripts/deploy-docs.sh
new file mode 100755
index 00000000..2c58d065
--- /dev/null
+++ b/scripts/deploy-docs.sh
@@ -0,0 +1,50 @@
+#!/usr/bin/env bash
+
+usage() { echo "Usage: $0 -v version -p path-to-github-io-dir [-d] " 1>&2; exit 1; }
+
+opt_version=""
+opt_path_to_remote=""
+opt_default='false'
+script_dir=$(dirname -- "${BASH_SOURCE[0]}")
+path_to_mkdocs_config="$(realpath -- "$script_dir";)/../mkdocs.yml"
+
+while getopts ":v:p:d" o; do
+    case "${o}" in
+        v)
+            opt_version=${OPTARG}
+            ;;
+        p)
+            opt_path_to_remote=${OPTARG}
+            ;;
+        d)
+            opt_default='true'
+            ;;
+        *)
+            usage
+            ;;
+    esac
+done
+
+shift $((OPTIND-1))
+
+if [[ -z "${opt_version}" ]]
+then
+    echo "Error: -v is required"
+    usage
+fi
+
+if [[ -z "${opt_path_to_remote}" ]]
+then
+    echo "Error: -p is required"
+    usage
+fi
+
+cd "$opt_path_to_remote"
+
+if ${opt_default}
+then
+    mike set-default -b main -F "$path_to_mkdocs_config" "$opt_version"
+    exit 0
+fi
+
+mike deploy -b main -F "$path_to_mkdocs_config" "$opt_version"