Skip to content

Commit c444f69

Browse files
committed
ENH: Add documentation build GHA workflow file
Add documentation build GHA workflow file.
1 parent 983e359 commit c444f69

File tree

1 file changed

+31
-0
lines changed

1 file changed

+31
-0
lines changed

.github/workflows/doc_build.yaml

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
name: Build docs
2+
3+
on:
4+
push:
5+
branches:
6+
- master
7+
tags:
8+
- 'v*'
9+
pull_request:
10+
branches:
11+
- master
12+
13+
jobs:
14+
build:
15+
16+
runs-on: ubuntu-latest
17+
18+
steps:
19+
- name: Check out repository
20+
uses: actions/checkout@v4
21+
with:
22+
fetch-depth: 0
23+
24+
- name: Install dependencies
25+
run: |
26+
python -m pip install --upgrade --user pip setuptools coverage
27+
pip install .[doc]
28+
29+
- name: Build docs
30+
run: |
31+
make -C doc/ SPHINXOPTS="-W -v" BUILDDIR="$HOME/docs" OUTDIR="$HOME/html" html

0 commit comments

Comments
 (0)