Skip to content

Commit 285929f

Browse files
committed
Build docs during CI
1 parent 7ea679e commit 285929f

File tree

1 file changed

+27
-0
lines changed

1 file changed

+27
-0
lines changed

.github/workflows/test-docs.yaml

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
name: Test build docs on PR
2+
3+
on:
4+
pull_request:
5+
branches:
6+
- "*"
7+
8+
# Builds docs for both stable and master branches.
9+
# stable is placed in the root of the gh-pages branch, while master is placed at /devel
10+
11+
jobs:
12+
doc:
13+
name: Documentation
14+
runs-on: ubuntu-latest
15+
steps:
16+
- uses: actions/checkout@v3
17+
with:
18+
fetch-depth: 0
19+
- name: Install mdbook
20+
run: |
21+
mkdir mdbook
22+
curl -Lf https://github.com/rust-lang/mdBook/releases/download/v0.4.6/mdbook-v0.4.6-x86_64-unknown-linux-gnu.tar.gz | tar -xz --directory=./mdbook
23+
echo "`pwd`/mdbook" >> $GITHUB_PATH
24+
- name: Build book
25+
run: |
26+
cd doc/user-guide
27+
mdbook build

0 commit comments

Comments
 (0)