Skip to content

Commit 370f30a

Browse files
committed
add RTD config
1 parent afd9198 commit 370f30a

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

.readthedocs.yaml

+25
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# Read the Docs configuration file
2+
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
3+
4+
# Required
5+
version: 2
6+
7+
# Set the OS, Python version and other tools you might need
8+
build:
9+
os: ubuntu-22.04
10+
tools:
11+
rust: latest
12+
commands:
13+
# install cargo-binstall
14+
- >-
15+
curl
16+
-L --proto '=https' --tlsv1.2 -sSf
17+
https://raw.githubusercontent.com/cargo-bins/cargo-binstall/main/install-from-binstall-release.sh
18+
| bash
19+
# install mdbook and mdbook-alerts
20+
- cargo binstall -y mdbook mdbook-alerts
21+
# build docs
22+
- mdbook build docs
23+
# move HTML output to required RTD output path
24+
- mkdir -p ${READTHEDOCS_OUTPUT}
25+
- mv docs/book/html/ "${READTHEDOCS_OUTPUT}"

0 commit comments

Comments
 (0)