Skip to content

Commit

Permalink
CI: add extra doc test action (#67)
Browse files Browse the repository at this point in the history
  • Loading branch information
hagenw authored Apr 26, 2024
1 parent b0ed7f6 commit ed66ff3
Show file tree
Hide file tree
Showing 2 changed files with 44 additions and 5 deletions.
44 changes: 44 additions & 0 deletions .github/workflows/doc.yml
Original file line number Diff line number Diff line change
@@ -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
5 changes: 0 additions & 5 deletions .github/workflows/test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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'

0 comments on commit ed66ff3

Please sign in to comment.