Skip to content

Commit fdf2d82

Browse files
committed
docs: update readthedocs setup
Update the configuration so it works for two projects. Signed-off-by: Daniel Wagner <[email protected]>
1 parent 6fd76e1 commit fdf2d82

3 files changed

Lines changed: 50 additions & 13 deletions

File tree

.readthedocs.yaml

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,25 @@
11
# SPDX-License-Identifier: Apache-2.0
2-
32
version: 2
43

54
build:
65
os: ubuntu-24.04
76
tools:
8-
python: "3"
7+
python: "3.11"
8+
99
apt_packages:
1010
- meson
1111
- python3-lxml
1212
- docbook-xsl
1313
- xsltproc
1414
- pandoc
15-
jobs:
16-
post_install:
17-
- pip3 install lxml
18-
pre_build:
19-
- meson setup .build -Ddocs=rst -Ddocs-build=true -Dnvme=disabled -Dlibnvme=disabled -Dpython=disabled || cat .build/meson-logs/meson-log.txt
20-
- meson compile -C .build
15+
- asciidoc
16+
- xmlto
17+
18+
commands:
19+
- pip install lxml
20+
- scripts/build.sh docs
21+
- cp .build-ci/Documentation/nvme.html .build-ci/Documentation/index.html
22+
23+
output: .build-ci/Documentation
2124

22-
sphinx:
23-
configuration: .build/libnvme/doc/conf.py
25+
formats: []

libnvme/.readthedocs.yaml

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# SPDX-License-Identifier: Apache-2.0
2+
3+
version: 2
4+
5+
build:
6+
os: ubuntu-24.04
7+
tools:
8+
python: "3.11"
9+
10+
apt_packages:
11+
- meson
12+
- python3-lxml
13+
- docbook-xsl
14+
- xsltproc
15+
- pandoc
16+
17+
commands:
18+
- pip install lxml
19+
- scripts/build.sh rst_docs
20+
21+
sphinx:
22+
configuration: .build-ci/libnvme/doc/conf.py

scripts/build.sh

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,8 @@ usage() {
2323
echo " cross use cross toolchain to build"
2424
echo " coverage build coverage report"
2525
echo " distro build libnvme and nvme-cli separately"
26-
echo " docs build documentation"
26+
echo " docs build all documentation"
27+
echo " rst_docs build rst documentation only"
2728
echo " static build a static binary"
2829
echo " libnvme build only libnvme"
2930
echo ""
@@ -123,12 +124,24 @@ config_meson_coverage() {
123124

124125
config_meson_docs() {
125126
CC="${CC}" "${MESON}" setup \
127+
-Dnvme=disabled \
128+
-Dlibnvme=disabled \
126129
-Ddocs=all \
127130
-Ddocs-build=true \
128131
--prefix=/tmp/usr \
129132
"${BUILDDIR}"
130133
}
131134

135+
config_meson_rst_docs() {
136+
CC="${CC}" "${MESON}" setup \
137+
-Dnvme=disabled \
138+
-Dlibnvme=disabled \
139+
-Ddocs=rst \
140+
-Ddocs-build=true \
141+
--prefix=/tmp/usr \
142+
"${BUILDDIR}"
143+
}
144+
132145
config_meson_static() {
133146
CC="${CC}" "${MESON}" setup \
134147
--werror \
@@ -146,8 +159,8 @@ config_meson_libnvme() {
146159
CC="${CC}" "${MESON}" setup \
147160
--werror \
148161
--buildtype="${BUILDTYPE}" \
149-
-Dnvme=disabled \
150-
-Dlibnvme=enabled \
162+
-Dnvme=disabled \
163+
-Dlibnvme=enabled \
151164
"${BUILDDIR}"
152165
}
153166

0 commit comments

Comments
 (0)