diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 0000000..ffda996 --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,28 @@ +# Read the Docs configuration file +# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details + +# Required +version: 2 + +# Set the OS, Python version and other tools you might need +build: + os: ubuntu-22.04 + tools: + rust: latest + commands: + # install cargo-binstall + - >- + curl + -L --proto '=https' --tlsv1.2 -sSf + https://raw.githubusercontent.com/cargo-bins/cargo-binstall/main/install-from-binstall-release.sh + | bash + # add .cargo bin to PATH + # install mdbook and mdbook-alerts + # build docs + - >- + PATH=/home/docs/.cargo/bin:$PATH && + cargo binstall --install-path /home/docs/.cargo/bin -y mdbook mdbook-alerts && + mdbook build docs + # move HTML output to required RTD output path + - mkdir -p ${READTHEDOCS_OUTPUT} + - mv docs/book/html/ "${READTHEDOCS_OUTPUT}"