weekly-docs.yaml

name: Weekly Docs Build

on:
  schedule:
    - cron: '0 8 * * 1'
  workflow_dispatch:

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

jobs:
  docs:
    name: Docs build (${{ matrix.os }}, python ${{ matrix.python-version }})
    runs-on: ${{ matrix.os }}
    strategy:
      fail-fast: false
      matrix:
        os: [ubuntu-24.04, windows-2025, macos-15]
        python-version: ["3.12", "3.13", "3.14"]
    timeout-minutes: 30

    steps:
      - name: Checkout repo
        uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6

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

      - name: Install python dependencies
        run: |
          python -m pip install --upgrade pip
          python -m pip install -e .[docs]

      - name: Build docs (warnings as errors)
        run: |
          make -C docs clean
          make -C docs html SPHINXOPTS="-W --keep-going"

      - name: Upload docs artifacts on failure
        if: failure()
        uses: actions/upload-artifact@v4
        with:
          name: docs-${{ matrix.os }}-py${{ matrix.python-version }}-failure
          path: |
            docs/_build/**