.github/workflows/linkcheck.yaml

name: Documentation links

# Checking external links needs the network, so it is not part of CI: a link
# that is briefly unreachable would fail unrelated pull requests. Run it on a
# schedule instead, and let it be started by hand when needed.
on:
  schedule:
    - cron: "0 6 * * 1"
  workflow_dispatch:

concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true

jobs:
  linkcheck:
    name: Check external links
    runs-on: ubuntu-latest
    timeout-minutes: 20
    steps:
      - name: Check out code from GitHub
        uses: actions/checkout@v7.0.1
      - name: Set up Python
        uses: actions/setup-python@v7.0.0
        with:
          python-version: "3.13"
          check-latest: true
      - name: Install tox
        run: python -m pip install -U pip tox
      - name: Check that every external link still resolves
        run: tox -e linkcheck