test-docs-linkcheck.yml

---
# This workflow tests building the package docs and verifying links are live.
name: Build docs and check links

on:  # yamllint disable-line rule:truthy
  schedule:
    - cron: 20 4 * * 1  # every monday at 04:20 UTC
  workflow_dispatch:

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

permissions:
  contents: read

jobs:
  test_docs_linkcheck:
    if: ${{ github.repository == 'gboeing/osmnx' }}
    name: Build docs and check links
    runs-on: ubuntu-latest
    timeout-minutes: 5

    defaults:
      run:
        shell: bash -elo pipefail {0}

    steps:
      - name: Checkout repo
        uses: actions/checkout@v7

      - name: Install uv
        uses: astral-sh/setup-uv@v7
        with:
          cache-dependency-glob: pyproject.toml
          enable-cache: true

      - name: Install requirements
        run: uv sync --only-group docs

      - name: Build docs and check links
        run: |
          uv run sphinx-build --keep-going -E -W -b linkcheck ./docs/source ./docs/build/linkcheck