Skip to content

Commit ec2eb4a

Browse files
dwsuseigaw
authored andcommitted
build: add documentation CI build
Build the documentation in the CI build to catch formatting issues in the submissions. Signed-off-by: Daniel Wagner <[email protected]>
1 parent 9264569 commit ec2eb4a

2 files changed

Lines changed: 34 additions & 0 deletions

File tree

.github/workflows/docs.yaml

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
---
2+
name: docs
3+
4+
on:
5+
push:
6+
branches: [master]
7+
paths:
8+
- doc/**
9+
pull_request:
10+
branches: [master]
11+
paths:
12+
- doc/**
13+
14+
workflow_dispatch:
15+
16+
jobs:
17+
build-docs:
18+
name: build documentation
19+
runs-on: ubuntu-latest
20+
container:
21+
image: ghcr.io/igaw/linux-nvme/debian:latest
22+
steps:
23+
- uses: actions/checkout@v4
24+
- name: build
25+
run: |
26+
scripts/build.sh docs

scripts/build.sh

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ usage() {
2121
echo " and build them as shared libaries"
2222
echo " cross use cross toolchain to build"
2323
echo " coverage build coverage report"
24+
echo " docs build documentation"
2425
echo ""
2526
echo "configs with muon:"
2627
echo " [default] minimal static build"
@@ -110,6 +111,13 @@ config_meson_coverage() {
110111
"${BUILDDIR}"
111112
}
112113

114+
config_meson_docs() {
115+
CC="${CC}" "${MESON}" setup \
116+
-Ddocs=all \
117+
-Ddocs-build=true \
118+
"${BUILDDIR}"
119+
}
120+
113121
build_meson() {
114122
"${MESON}" compile \
115123
-C "${BUILDDIR}"

0 commit comments

Comments
 (0)