build: provide mdBook in Nix shell

This commit is contained in:
Onur Özkan committed 2026-08-09 14:29:12 +03:00
1 parent 8f91247f10
commit a4f04cfa7e
3 files changed
+5 -4

No files matched your search

+1 -1
View File
@@ -33,7 +33,7 @@ jobs:
uses: actions/configure-pages@v5 uses: actions/configure-pages@v5
- name: Install mdBook - name: Install mdBook
run: cargo install mdbook --version 0.5.2 --locked run: cargo install mdbook --version 0.5.3 --locked
- name: Build the site - name: Build the site
run: mdbook build docs run: mdbook build docs
+3 -3
View File
@@ -30,11 +30,11 @@ Do not add board-local READMEs. Add a page here instead, then link it from
## Build the documentation website ## Build the documentation website
The manual is an [mdBook](https://rust-lang.github.io/mdBook/) project. Build The manual is an [mdBook](https://rust-lang.github.io/mdBook/) project. The
it locally with a compatible `mdbook` binary: repository's Nix development shell provides the checked tool version:
```sh ```sh
make -C docs build nix develop -c make -C docs build
``` ```
The generated static site is written to `target/docs/`. The GitHub Pages The generated static site is written to `target/docs/`. The GitHub Pages
+1
View File
@@ -25,6 +25,7 @@
packages = [ packages = [
pkgs.rustup pkgs.rustup
pkgs.dfu-util pkgs.dfu-util
pkgs.mdbook
python python
]; ];
}; };