test_build.yml

# Build documentation and upload to gh-pages
name: Ensure documentation builds after commits

defaults:
  run:
    shell: bash

env:
  UV_COMPILE_BYTECODE: 1

on: [push, pull_request]  # Runs on all push events to any branch

jobs:
  documentation:
    name: Build Static Documentation
    runs-on: ubuntu-latest

    steps:
      - uses: actions/checkout@v4

      - name: Install uv and Python
        uses: astral-sh/setup-uv@v6
        with:
          python-version: 3.13
          enable-cache: true
          activate-environment: true
          cache-dependency-glob: "requirements.txt"

      - name: Install dependencies
        run: uv pip install -r requirements.txt

      - name: Build documentation
        run: python -m mkdocs build -d ./doc_build

      # Upload artifacts if in PR so reviewers can have a quick look without building documentation from the branch locally
      - name: Upload build artifacts
        uses: actions/upload-artifact@v4
        if: success() && github.event_name == 'pull_request'
        with:
          name: site-build
          path: doc_build
          retention-days: 5