Skip to content

Commit

Permalink
build: add documentation CI build
Browse files Browse the repository at this point in the history
Build the documentation in the CI build to catch formatting issues in
the submissions.

Signed-off-by: Daniel Wagner <[email protected]>
  • Loading branch information
igaw committed Jul 10, 2024
1 parent 9264569 commit ec2eb4a
Show file tree
Hide file tree
Showing 2 changed files with 34 additions and 0 deletions.
26 changes: 26 additions & 0 deletions .github/workflows/docs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
---
name: docs

on:
push:
branches: [master]
paths:
- doc/**
pull_request:
branches: [master]
paths:
- doc/**

workflow_dispatch:

jobs:
build-docs:
name: build documentation
runs-on: ubuntu-latest
container:
image: ghcr.io/igaw/linux-nvme/debian:latest
steps:
- uses: actions/checkout@v4
- name: build
run: |
scripts/build.sh docs
8 changes: 8 additions & 0 deletions scripts/build.sh
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ usage() {
echo " and build them as shared libaries"
echo " cross use cross toolchain to build"
echo " coverage build coverage report"
echo " docs build documentation"
echo ""
echo "configs with muon:"
echo " [default] minimal static build"
Expand Down Expand Up @@ -110,6 +111,13 @@ config_meson_coverage() {
"${BUILDDIR}"
}

config_meson_docs() {
CC="${CC}" "${MESON}" setup \
-Ddocs=all \
-Ddocs-build=true \
"${BUILDDIR}"
}

build_meson() {
"${MESON}" compile \
-C "${BUILDDIR}"
Expand Down

0 comments on commit ec2eb4a

Please sign in to comment.