release_doc_warnings.yml

name: 'RELEASE: Build docs'

on:
  pull_request:
    types:
      - opened
      - reopened
      - synchronize
      - ready_for_review
    branches:
      - stable

jobs:
  docs_warnings_as_errors:
    name: with warnings as errors
    runs-on: 'ubuntu-latest'
    concurrency:
      group: ${{ github.workflow }}-${{ github.ref }}
      cancel-in-progress: true
    if: ${{ !github.event.pull_request.draft }}

    steps:
    - name: Check out repo
      uses: actions/checkout@0c366fd6a839edf440554fa01a7085ccba70ac98
      with:
        persist-credentials: false

    - name: Install Python
      uses: actions/setup-python@28f2168f4d98ee0445e3c6321f6e6616c83dd5ec
      with:
        python-version: '3.13'
        cache: 'pip'
        cache-dependency-path: requirements-rtd.txt

    - name: Install project and docs requirements
      run: pip install . -r requirements-rtd.txt

    - name: Build docs with warnings as errors
      run: |
        cd doc
        make html -Wn --keep-going