Skip to content

Commit cb977c1

Browse files
committed
build: add documentation CI build
Build the documentation in the CI build to catch formatting issues in the submissions. Signed-off-by: Daniel Wagner <dwagner@suse.de>
1 parent eb659fe commit cb977c1

File tree

2 files changed

+36
-0
lines changed

2 files changed

+36
-0
lines changed

.github/workflows/docs.yaml

+26
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+
- Documentation/**
9+
pull_request:
10+
branches: [master]
11+
paths:
12+
- Documentation/**
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

+10
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ usage() {
2222
echo " coverage build coverage report"
2323
echo " appimage build AppImage target"
2424
echo " distro build libnvme and nvme-cli separately"
25+
echo " docs build documentation"
2526
echo ""
2627
echo "configs with muon:"
2728
echo " [default] minimal static build"
@@ -116,6 +117,15 @@ config_meson_appimage() {
116117
"${BUILDDIR}"
117118
}
118119

120+
config_meson_docs() {
121+
CC="${CC}" "${MESON}" setup \
122+
-Ddocs=all \
123+
-Ddocs-build=true \
124+
--force-fallback-for=libnvme \
125+
-Dlibnvme:werror=false \
126+
"${BUILDDIR}"
127+
}
128+
119129
build_meson() {
120130
"${MESON}" compile \
121131
-C "${BUILDDIR}"

0 commit comments

Comments
 (0)