Skip to content

Commit 89deea8

Browse files
authored
docs: work around RTD env not having rust 1.88+ available (#97)
Should be reverted within 6 months when RTD updates their env's asdf offerings
1 parent 45f940d commit 89deea8

2 files changed

Lines changed: 9 additions & 3 deletions

File tree

.config/.readthedocs.yaml

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,21 +11,26 @@ build:
1111
# - libgpiod-dev
1212
tools:
1313
nodejs: latest
14-
rust: latest
14+
# see acceptable inputs at https://docs.readthedocs.com/platform/stable/config-file/v2.html#build-tools-rust
15+
# rust: latest
1516
python: latest
1617
jobs:
1718
pre_create_environment:
19+
# Workaround until Read the Docs env upgrades to rust v1.88 or later.
20+
# Install Rust using rustup with minimal profile.
21+
# This also mandates that the PATH be prepended with ${HOME}/.cargo/bin in subsequent commands.
22+
- curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- --profile minimal -y
1823
- >-
1924
UV_INSTALL_DIR="${HOME}/.local/bin" &&
2025
curl -LsSf https://astral.sh/uv/install.sh | sh
21-
- ${HOME}/.local/bin/uv sync --group docs
26+
- PATH="${HOME}/.cargo/bin:${PATH}" && ${HOME}/.local/bin/uv sync --group docs
2227
post_create_environment:
2328
- corepack enable
2429
- corepack prepare --activate yarn@4.9.2
2530
- asdf reshim nodejs
2631
pre_build:
2732
- yarn install
28-
- yarn build:debug
33+
- PATH="${HOME}/.cargo/bin:${PATH}" && yarn build:debug
2934
- yarn docs
3035
build:
3136
html:

cspell.config.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -109,6 +109,7 @@ words:
109109
- taiki
110110
- tasklist
111111
- timeit
112+
- tlsv
112113
- twemoji
113114
- typdedoc
114115
- yarnrc

0 commit comments

Comments
 (0)