sphinx.yml

name: Sphinx Builds
on:
  push:
  pull_request:
    types: [synchronize, opened]
jobs:
  build:
    name: Build
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v4
    - name: Set up Python
      uses: actions/setup-python@v2
      with:
        python-version: '<=3.9'
    - name: Cache pip
      uses: actions/cache@v2
      with:
        path: ~/.cache/pip
        key: ${{ runner.os }}-pip-${{ hashFiles('requirements.txt') }}
        restore-keys: |
          ${{ runner.os }}-pip-
          ${{ runner.os }}-
    - name: Install dependencies
      run: |
        python -m pip install --upgrade pip
        pip install -r docs/requirements.txt
        sudo apt-get update -y
        sudo apt-get install -y pandoc
    - name: Ensure sphinx builds (warnings allowed)
      run: |
        cp -r Tutorials/ docs/
        make -C docs html O=-n