diff --git a/.github/workflows/doc.yml b/.github/workflows/doc.yml new file mode 100644 index 0000000..8f2f11d --- /dev/null +++ b/.github/workflows/doc.yml @@ -0,0 +1,44 @@ +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 + diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index 7236787..bbf06f2 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -41,8 +41,3 @@ jobs: token: ${{ secrets.CODECOV_TOKEN }} file: ./coverage.xml if: matrix.os == 'ubuntu-latest' - - name: Test building documentation - run: | - python -m sphinx docs/ docs/_build/ -b html -W - python -m sphinx docs/ docs/_build/ -b linkcheck -W - if: matrix.os == 'ubuntu-latest'