docs.yml

name: Documentation
on:
  push:
  pull_request:

env:
  UV_SYSTEM_PYTHON: 1

jobs:
  run:
    runs-on: ubuntu-latest
    env:
      DJANGO_CA_SECRET_KEY: dummy
    steps:

      - name: Acquire sources
        uses: actions/checkout@v4.1.1

      - name: Setup Python
        uses: actions/setup-python@v5.0.0
        with:
          # Python 3.13 currently fails
          python-version: "3.12"
          architecture: x64

      - name: Install uv
        uses: astral-sh/setup-uv@v4
        with:
          enable-cache: true
          cache-dependency-glob: "requirements.txt"

      - name: Update setuptools/wheel
        run: uv pip install -U setuptools wheel

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

      - name: doc8 style checks
        run: doc8 docs/source/

      - name: Generate documentation
        run: make -C docs html

      - name: Spelling
        run: make -C docs spelling