Skip to content

Commit 0c9feef

Browse files
committed
build: rtd: only build html docs for nvme-cli
There is no need to build all the documentation for RTD, html is enough. This reduces the amount of dependencies for the build, e.g. no sphinx necessary. Signed-off-by: Daniel Wagner <[email protected]>
1 parent c3bf206 commit 0c9feef

2 files changed

Lines changed: 12 additions & 0 deletions

File tree

.readthedocs.yaml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ build:
1111
- docbook-xsl
1212
- xsltproc
1313
- pandoc
14+
- asciidoc
1415
jobs:
1516
build:
1617
html:

scripts/build.sh

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ usage() {
2424
echo " coverage build coverage report"
2525
echo " distro build libnvme and nvme-cli separately"
2626
echo " docs build all documentation"
27+
echo " html_docs build html documentation only"
2728
echo " rst_docs build rst documentation only"
2829
echo " static build a static binary"
2930
echo " libnvme build only libnvme"
@@ -132,6 +133,16 @@ config_meson_docs() {
132133
"${BUILDDIR}"
133134
}
134135

136+
config_meson_html_docs() {
137+
CC="${CC}" "${MESON}" setup \
138+
-Dnvme=disabled \
139+
-Dlibnvme=disabled \
140+
-Ddocs=html \
141+
-Ddocs-build=true \
142+
--prefix=/tmp/usr \
143+
"${BUILDDIR}"
144+
}
145+
135146
config_meson_rst_docs() {
136147
CC="${CC}" "${MESON}" setup \
137148
-Dnvme=disabled \

0 commit comments

Comments
 (0)