Skip to content

Commit

Permalink
Fixes mdbook (#379)
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
BradyBonnette authored Sep 6, 2023
1 parent 53bbeea commit 2eaa9ee
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 10 deletions.
3 changes: 1 addition & 2 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,7 @@ jobs:
echo "PATH=$HOME/.cargo/bin:$PATH" >> $GITHUB_ENV
- name: Install mdbook and other preprocessors
run: |
cargo install mdbook --version 0.4.32
cargo install mdbook-variables --version 0.2.1
cargo install --locked mdbook-variables mdbook
- name: Deploy GitHub Pages
run: |
# This assumes your book is in the root of your repository.
Expand Down
10 changes: 3 additions & 7 deletions doc/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,13 @@

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

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

```bash
cargo install mdbook --version 0.4.32
cargo install --locked mdbook-variables mdbook
```

Install mdbook-variables preprocessor -- exact version is required since (at the time of this writing) there were some compatibility issues.

```bash
cargo install mdbook-variables --version 0.2.1
```
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

Serve the book locally and open your default browser.

Expand Down
2 changes: 1 addition & 1 deletion plrust/build
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ if [ `uname` == "Darwin" ]; then
else
echo unsupported macos build platform: $(uname -m)
exit 1
fi
fi

else
if [ `uname -m` == "x86_64" ]; then
Expand Down

0 comments on commit 2eaa9ee

Please sign in to comment.