docs.yml

---
name: Docs

on:
  pull_request:
  push:
    branches: [ main ]

  # Allow job to be triggered manually.
  workflow_dispatch:

# Cancel in-progress jobs when pushing to the same branch.
concurrency:
  cancel-in-progress: true
  group: ${{ github.workflow }}-${{ github.ref }}

jobs:

  tests:

    runs-on: "ubuntu-latest"
    strategy:
      fail-fast: false
      matrix:
        python-version: [
          "3.14",
        ]

    env:
      PYTHON: ${{ matrix.python-version }}
      UV_SYSTEM_PYTHON: true

    name: Link checker
    steps:

    - name: Acquire sources
      uses: actions/checkout@v6

    - name: Set up Python
      uses: actions/setup-python@v6
      with:
        python-version: ${{ matrix.python-version }}

    - name: Set up uv
      uses: astral-sh/setup-uv@v7
      with:
        cache-dependency-glob: |
          pyproject.toml
        cache-suffix: ${{ matrix.python-version }}
        enable-cache: true
        version: "latest"

    - name: Set up project
      run: |

        # Install package in editable mode.
        uv pip install --editable='.[develop,docs]'

    - name: Run link checker
      run: |
        poe docs-linkcheck