From a2bc5253e06fd5f4f8e7d0d7f1ca44ea20f9c822 Mon Sep 17 00:00:00 2001
From: tjex <tjex@tjex.net>
Date: Tue, 17 Sep 2024 12:38:45 +0200
Subject: [PATCH] add workflow to test docs build on pr

---
 .github/workflows/build-docs.yml | 26 ++++++++++++++++++++++++++
 1 file changed, 26 insertions(+)
 create mode 100644 .github/workflows/build-docs.yml

diff --git a/.github/workflows/build-docs.yml b/.github/workflows/build-docs.yml
new file mode 100644
index 00000000..ef926c56
--- /dev/null
+++ b/.github/workflows/build-docs.yml
@@ -0,0 +1,26 @@
+# Build the Sphinx docs on PR to catch any issues before merging.
+# Deployment happens on push to main with gh-pages.yml
+name: Build Docs
+
+on:
+  pull_request:
+    branches: [main]
+
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  pages:
+    runs-on: ubuntu-20.04
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    permissions:
+      pages: write
+      id-token: write
+    steps:
+    - id: deployment
+      uses: sphinx-notes/pages@v3
+      with:
+        publish: false