Skip to content

Commit 8a0713c

Browse files
Build documentation in CI and fail on warnings (#511)
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
1 parent 309dabb commit 8a0713c

1 file changed

Lines changed: 22 additions & 0 deletions

File tree

‎.github/workflows/docs.yml‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
name: Docs
2+
3+
on: [push, pull_request, workflow_dispatch]
4+
5+
permissions:
6+
contents: read
7+
8+
jobs:
9+
docs:
10+
name: Build documentation
11+
runs-on: ubuntu-latest
12+
steps:
13+
- uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
14+
with:
15+
persist-credentials: false
16+
- uses: actions/setup-python@6d4fd22b20465ccc0f7354476588e8df7c9ca0e0 # v7.1.0
17+
with:
18+
python-version: "3.15"
19+
- name: Install dependencies
20+
run: python -m pip install sphinx
21+
- name: Build documentation
22+
run: make -C doc clean html SPHINXOPTS=--fail-on-warning

0 commit comments

Comments
 (0)