ci: Add documentation workflow

Build the documentation as part of CI.

Signed-off-by: Pieter De Gendt <[email protected]>

Author: pdgendt

.github/workflows/docs.yml

@@ -0,0 +1,43 @@
+name: Build documentation
+
+on: [push, pull_request]
+
+permissions:
+  contents: read
+
+# Cancel ongoing builds on new changes
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event_name }}-${{ github.head_ref || github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  build:
+    name: Run tasks
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
+        with:
+          persist-credentials: false
+
+      - name: Set up Python
+        uses: actions/setup-python@e797f83bcb11b83ae66e0230d6156d7c80228e7c # v6.0.0
+        with:
+          python-version: "3.14"
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@b75a909f75acd358c2196fb9a5f1299a9a8868a4 # v6.7.0
+        with:
+          enable-cache: true
+
+      - name: Install dependencies
+        run: uv sync --frozen --group docs
+
+      - name: Build documentation
+        run: uv run poe build-docs
+
+      - name: Upload artifacts
+        uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4.6.2
+        with:
+          path: doc/_build
+          include-hidden-files: true

pyproject.toml

@@ -119,6 +119,10 @@ ignore_missing_imports = true
 cmd = "python -m pytest -v -W error --junitxml=junit.xml -o junit_family=xunit1 --cov-report=html --cov-config=pyproject.toml --cov=west"
 env = {PYTHONIOENCODING = "utf-8"}
 
+[tool.poe.tasks.build-docs]
+cmd = "sphinx-build -M html . _build"
+cwd = "./doc"
+
 [tool.poe.tasks]
 lint = "ruff check ."
 format = "ruff format"