Skip to content

Commit

Permalink
[GH-Actions] Add doc-tests
Browse files Browse the repository at this point in the history
Signed-off-by: Cristian Le <[email protected]>
  • Loading branch information
LecrisUT committed Nov 17, 2023
1 parent 4b7d4e6 commit 9b6b534
Showing 1 changed file with 33 additions and 0 deletions.
33 changes: 33 additions & 0 deletions .github/workflows/doc-tests.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
name: test-docs
run-name: Documentation tests

on:
pull_request:
push:
branches: [master]

permissions:
contents: read

jobs:
doc-test:
name: Sphinx-${{ matrix.builder }}
runs-on: ubuntu-latest
continue-on-error: ${{ matrix.experimental || false }}
strategy:
fail-fast: false
matrix:
builder: [ linkcheck, doctest, html ]
include:
# Run default html builder with warnings as error
- builder: html
args: -W
steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v4
with:
python-version: 3.x
- name: Install the project and docs dependencies
run: pip install -e .[docs]
- name: Run sphinx builder ${{ matrix.builder }}
run: sphinx-build -b ${{ matrix.builder }} ${{ matrix.args }} ./docs ./docs/_build

0 comments on commit 9b6b534

Please sign in to comment.