From f49226a402f0657ba60bea41ed1c68817dd9b992 Mon Sep 17 00:00:00 2001 From: "Celina G. Val" Date: Tue, 4 Jun 2024 16:14:05 -0700 Subject: [PATCH] Fix the book script (#8) Fix the book script and add a little blob to the Kani page. --- .github/workflows/book.yml | 16 ++++++++++++---- doc/src/tools/kani.md | 6 ++++++ 2 files changed, 18 insertions(+), 4 deletions(-) diff --git a/.github/workflows/book.yml b/.github/workflows/book.yml index 9e0982b41349a..5d8c95b6c3b66 100644 --- a/.github/workflows/book.yml +++ b/.github/workflows/book.yml @@ -1,7 +1,13 @@ # Copyright Kani Contributors # SPDX-License-Identifier: Apache-2.0 OR MIT + +# This workflow is responsible for building and releasing the contest book. +# It should only run when there has been a change to the contest book files +# or via manual trigger. + name: Build Book on: + workflow_dispatch: pull_request: paths: - 'doc/**' @@ -17,16 +23,18 @@ jobs: uses: actions/checkout@v4 - name: Install mdbook - run: cargo install mdbook --version "^0.4" --locked + run: | + cargo install mdbook --version "^0.4" --locked + echo "${HOME}/.cargo/bin" >> $GITHUB_PATH - name: Install linkchecker - run: cargo install mdbook-linkcheck "0.7" --locked + run: cargo install mdbook-linkcheck --version "^0.7" --locked - name: Build Documentation - run: mkdbook build doc + run: mdbook build doc - name: Upload book - uses: actions/upload-pages-artifact@v4 + uses: actions/upload-pages-artifact@v3 with: path: book/html retention-days: "2" diff --git a/doc/src/tools/kani.md b/doc/src/tools/kani.md index f956975e31b03..2b7b008f098fb 100644 --- a/doc/src/tools/kani.md +++ b/doc/src/tools/kani.md @@ -1 +1,7 @@ # Kani Rust Verifier + +The Kani Rust Verifier is a bit-precise model checker for Rust. +This page will give more details on how to use Kani to verify the standard library. +You can find more informations about how to install and use Kani in the +[Kani book](https://model-checking.github.io/kani/). +