run-docs-build.yml

name : Run Docs Build

on: [push, pull_request]

jobs:
  test:
    runs-on: ${{ matrix.os }}
    timeout-minutes: 5
    env:
      PIP_NO_PIP_VERSION_CHECK: 1
      PIP_CACHE_DIR: .pip-cache
      PIP_PREFER_BINARY: 1

    strategy:
      fail-fast: False
      matrix:
        include:
          - os: ubuntu-20.04
            python: "3.9"

    steps:
      - uses: actions/checkout@v4
      - name: Setup Python
        uses: actions/setup-python@v5
        with:
          python-version: ${{ matrix.python }}

      - name: Setup Pip Cache
        uses: actions/cache@v4
        with:
          path: .pip-cache
          key: ${{ runner.os }}-py-${{ matrix.python }}-pip-${{ hashFiles('setup.*', '.github/workflows/run-docs-build.yml') }}
          restore-keys: |
            ${{ runner.os }}-py-${{ matrix.python }}-pip

      - name: Install Doc Deps
        run: python -m pip install -r docs/requirements-rtd.txt

      - name: Install
        run: python -m pip install -e .

      - name: List Build Env
        run: pip list --format=freeze

      - name: Build Docs
        run: (cd docs; make SPHINXOPTS="-W --keep-going" html)