Skip to content

Commit f49226a

Browse files
authoredJun 4, 2024
Fix the book script (#8)
Fix the book script and add a little blob to the Kani page.
1 parent 9dd4def commit f49226a

File tree

2 files changed

+18
-4
lines changed

2 files changed

+18
-4
lines changed
 

Diff for: ‎.github/workflows/book.yml

+12-4
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,13 @@
11
# Copyright Kani Contributors
22
# SPDX-License-Identifier: Apache-2.0 OR MIT
3+
4+
# This workflow is responsible for building and releasing the contest book.
5+
# It should only run when there has been a change to the contest book files
6+
# or via manual trigger.
7+
38
name: Build Book
49
on:
10+
workflow_dispatch:
511
pull_request:
612
paths:
713
- 'doc/**'
@@ -17,16 +23,18 @@ jobs:
1723
uses: actions/checkout@v4
1824

1925
- name: Install mdbook
20-
run: cargo install mdbook --version "^0.4" --locked
26+
run: |
27+
cargo install mdbook --version "^0.4" --locked
28+
echo "${HOME}/.cargo/bin" >> $GITHUB_PATH
2129
2230
- name: Install linkchecker
23-
run: cargo install mdbook-linkcheck "0.7" --locked
31+
run: cargo install mdbook-linkcheck --version "^0.7" --locked
2432

2533
- name: Build Documentation
26-
run: mkdbook build doc
34+
run: mdbook build doc
2735

2836
- name: Upload book
29-
uses: actions/upload-pages-artifact@v4
37+
uses: actions/upload-pages-artifact@v3
3038
with:
3139
path: book/html
3240
retention-days: "2"

Diff for: ‎doc/src/tools/kani.md

+6
Original file line numberDiff line numberDiff line change
@@ -1 +1,7 @@
11
# Kani Rust Verifier
2+
3+
The Kani Rust Verifier is a bit-precise model checker for Rust.
4+
This page will give more details on how to use Kani to verify the standard library.
5+
You can find more informations about how to install and use Kani in the
6+
[Kani book](https://model-checking.github.io/kani/).
7+

0 commit comments

Comments
 (0)
Please sign in to comment.