Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix the book script #8

Merged
merged 3 commits into from
Jun 4, 2024
Merged

Fix the book script #8

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ed9c74a
Fix upload artifacts version
celinval Jun 4, 2024
c61dc80
Fix book and add a little blob in the kani.md file
celinval Jun 4, 2024
b6aac7a
Merge branch 'main' into contest-0000-fix-book
celinval Jun 4, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 12 additions & 4 deletions .github/workflows/book.yml
View file
Open in desktop
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,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"
Expand Down
6 changes: 6 additions & 0 deletions doc/src/tools/kani.md
View file
Open in desktop
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/).