Skip to content

Commit 2eaa9ee

Browse files
Fixes mdbook (#379)
There was a problem with compiling and installing mdbook and mdbook-variables in the main TCDI plrust repo. These changes address the issue it was having, albeit a temporary band-aid until the author fixes the library proper.
1 parent 53bbeea commit 2eaa9ee

File tree

3 files changed

+5
-10
lines changed

3 files changed

+5
-10
lines changed

.github/workflows/docs.yml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,7 @@ jobs:
1818
echo "PATH=$HOME/.cargo/bin:$PATH" >> $GITHUB_ENV
1919
- name: Install mdbook and other preprocessors
2020
run: |
21-
cargo install mdbook --version 0.4.32
22-
cargo install mdbook-variables --version 0.2.1
21+
cargo install --locked mdbook-variables mdbook
2322
- name: Deploy GitHub Pages
2423
run: |
2524
# This assumes your book is in the root of your repository.

doc/README.md

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,13 @@
22

33
The book is built [using `mdbook`](https://rust-lang.github.io/mdBook/index.html).
44

5-
Install mdbook -- exact version is required since (at the time of this writing) there were some compatibility issues.
5+
To install everything you need, run the following:
66

77
```bash
8-
cargo install mdbook --version 0.4.32
8+
cargo install --locked mdbook-variables mdbook
99
```
1010

11-
Install mdbook-variables preprocessor -- exact version is required since (at the time of this writing) there were some compatibility issues.
12-
13-
```bash
14-
cargo install mdbook-variables --version 0.2.1
15-
```
11+
Note that at the time of this writing, you may see a warning message similar to: `Warning: The variables plugin was built against version 0.4.32 of mdbook, but we're being called from version 0.4.34`. This is a known issue from the mdbook-variables author. See here: https://gitlab.com/tglman/mdbook-variables/-/issues/3
1612

1713
Serve the book locally and open your default browser.
1814

plrust/build

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ if [ `uname` == "Darwin" ]; then
2828
else
2929
echo unsupported macos build platform: $(uname -m)
3030
exit 1
31-
fi
31+
fi
3232

3333
else
3434
if [ `uname -m` == "x86_64" ]; then

0 commit comments

Comments
 (0)