links.yaml

---
name: Lychee link checker

on:
  workflow_dispatch:
  schedule:
    # Run weekly on Sundays at 3 AM UTC to catch broken links
    - cron: '0 3 * * 0'

permissions:
  contents: read

jobs:
  link-checker:
    name: Lychee link checker
    runs-on: ubuntu-latest

    steps:
      - name: Checkout
        uses: actions/checkout@v6

      - name: Install uv
        uses: astral-sh/setup-uv@v5
        with:
          python-version: '3.12'
          enable-cache: true

      - name: Create virtual environment
        run: |
          uv venv --clear .venv
          echo "$GITHUB_WORKSPACE/.venv/bin" >> $GITHUB_PATH

      - name: Install dependencies
        run: uv pip install -e ".[docs]"

      - name: Build documentation with Sphinx
        run: |
          sphinx-build -b html docs docs/_build/html

      - name: Link Checker on built documentation
        id: lychee
        uses: lycheeverse/lychee-action@v2.8.0
        with:
          # Check the built HTML files recursively (includes internal links)
          args: --config lychee.toml --verbose --no-progress --max-redirects 10 'docs/_build/html/**/*.html'
          fail: true