From ef9ed2359e4efae0196ef92e1b30a6913fe04fad Mon Sep 17 00:00:00 2001
From: Corran Webster <cwebster@unital.dev>
Date: Fri, 13 Sep 2024 08:42:41 +0100
Subject: [PATCH] Add a github action for documentation building. (#13)

---
 .github/workflows/build_docs.yaml | 25 +++++++++++++++++++++++++
 dev-requirements.txt              |  1 -
 2 files changed, 25 insertions(+), 1 deletion(-)
 create mode 100644 .github/workflows/build_docs.yaml

diff --git a/.github/workflows/build_docs.yaml b/.github/workflows/build_docs.yaml
new file mode 100644
index 0000000..e5bfee7
--- /dev/null
+++ b/.github/workflows/build_docs.yaml
@@ -0,0 +1,25 @@
+name: "Pull Request Docs Check"
+
+on:
+- workflow_dispatch
+- pull_request
+
+jobs:
+  docs:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python 3.11
+      uses: actions/setup-python@v5
+      with:
+        python-version: '3.11'
+    - name: Install dependencies and local packages
+      run: python -m pip install sphinx pydata-sphinx-theme
+    - name: Build HTML documentation with Sphinx
+      run: make html
+      working-directory: docs
+    - uses: actions/upload-artifact@v4
+      with:
+        name: documentation
+        path: docs/build/html
+        retention-days: 7
diff --git a/dev-requirements.txt b/dev-requirements.txt
index 7436bb7..458494d 100644
--- a/dev-requirements.txt
+++ b/dev-requirements.txt
@@ -3,4 +3,3 @@ micropy-cli
 mpremote
 pydata-sphinx-theme
 sphinx
-unittest