doc.yml

name: Documentation

on:
  push:
    branches: [ main ]
  pull_request:
    branches: [ main ]

jobs:
  build:

    runs-on: ${{ matrix.os }}
    strategy:
      matrix:
        os: [ ubuntu-latest ]
        python-version: [ '3.10' ]

    steps:
    - uses: actions/checkout@v4

    - name: Set up Python ${{ matrix.python-version }}
      uses: actions/setup-python@v5
      with:
        python-version: ${{ matrix.python-version }}

    - name: Ubuntu - install libsndfile
      run: |
        sudo apt-get update
        sudo apt-get install --no-install-recommends --yes libsndfile1

    - name: Install package
      run: |
        python -m pip install --upgrade pip
        pip install -r requirements.txt

      # DOCS
    - name: Install docs requirements
      run: pip install -r docs/requirements.txt

    - name: Test building user documentation
      run: |
        python -m sphinx docs/ build/html/ -b html -W
        python -m sphinx docs/ build/html -b linkcheck -W