docs.yml

# Modified from GitHub Actions template

name: Documentation

on:
  push:
    branches: [master]
  pull_request:
    branches: [master]

jobs:
  build-docs:
    runs-on: ubuntu-latest
    strategy:
      matrix:
        python-version: ['3.9', '3.10', '3.11']
    steps:
    - uses: actions/checkout@v2
    - name: Setup Python ${{ matrix.python-version }}
      uses: actions/setup-python@v2
      with:
        python-version: ${{ matrix.python-version }}
    - name: Install dependencies
      run: |
        sudo apt-get install pandoc
        python -m pip install --upgrade pip
        pip install pytest
        pip install numpy
        if [ -f doc/requirements.txt ]; then pip install -r doc/requirements.txt; fi
        wget https://github.com/errata-ai/vale/releases/download/v2.15.4/vale_2.15.4_Linux_64-bit.tar.gz
        mkdir ~/bin && tar -xvzf vale_2.15.4_Linux_64-bit.tar.gz -C ~/bin
    - name: Test Building Documentation
      run: |
        doc/test.sh ci
    - name: Lint the Documentation
      run: |
        PATH="~/bin:$PATH" doc/lint.sh ci