Skip to content

Commit

Permalink
Fix book and add a little blob in the kani.md file
Browse files Browse the repository at this point in the history
  • Loading branch information
celinval committed Jun 4, 2024
1 parent ed9c74a commit c61dc80
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 2 deletions.
12 changes: 10 additions & 2 deletions .github/workflows/book.yml
Original file line number Diff line number Diff line change
@@ -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/**'
Expand All @@ -17,13 +23,15 @@ 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 --version "^0.7" --locked

- name: Build Documentation
run: mkdbook build doc
run: mdbook build doc

- name: Upload book
uses: actions/upload-pages-artifact@v3
Expand Down
6 changes: 6 additions & 0 deletions doc/src/tools/kani.md
Original file line number Diff line number Diff line change
@@ -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/).

0 comments on commit c61dc80

Please sign in to comment.