Skip to content

Commit

Permalink
Add doc-tests to GH-Actions
Browse files Browse the repository at this point in the history
Signed-off-by: Cristian Le <[email protected]>
  • Loading branch information
LecrisUT committed May 6, 2024
1 parent a760405 commit e1741b8
Show file tree
Hide file tree
Showing 2 changed files with 31 additions and 1 deletion.
30 changes: 30 additions & 0 deletions .github/workflows/doc-tests.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
name: test-docs
run-name: Documentation tests

on:
pull_request:
push:
branches: [main]

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: [ html ]
include:
# Run default html builder with warnings as error
- builder: html
args: -W
steps:
- uses: actions/checkout@v4
- name: Run sphinx builder ${{ matrix.builder }}
run: |
pip install hatch
hatch run docs:${{ matrix.builder }} ${{ matrix.args }}
2 changes: 1 addition & 1 deletion .github/workflows/pre-commit.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ name: pre-commit
on:
pull_request:
push:
branches: [master]
branches: [main]

jobs:
pre-commit:
Expand Down

0 comments on commit e1741b8

Please sign in to comment.