Skip to content

Publish our crates documentation #1994

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

Merged
merged 3 commits into from
Dec 13, 2022
Merged

Publish our crates documentation #1994

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
f3227e0
Publish our crates documentation
celinval Dec 13, 2022
490dbbc
Fix link
celinval Dec 13, 2022
6a199ff
Apply suggestions from code review
celinval Dec 13, 2022
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
2 changes: 2 additions & 0 deletions docs/src/SUMMARY.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,3 +34,5 @@
- [Intrinsics](./rust-feature-support/intrinsics.md)
- [Unstable features](./rust-feature-support/unstable.md)
- [Overrides](./overrides.md)

- [Crates Documentation](./crates/index.md)
14 changes: 14 additions & 0 deletions docs/src/crates/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Crates documentation

Kani currently ships with a couple crates that provide APIs to allow users to
write and configure their harnesses.
These APIs are tightly coupled with each Kani version, so they are not
published yet at <crates.io>.

You can find their latest documentation here:
- [kani](https://model-checking.github.io/kani/crates/kani): This crate
provide APIs to write Kani harnesses.
- [kani_macros](https://model-checking.github.io/kani/crates/kani_macros):
This crate provides `proc_macro` definitions that allow users to configure their
harnesses using function attributes.

4 changes: 4 additions & 0 deletions scripts/build-docs.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,4 +65,8 @@ $SCRIPT_DIR/mdbook build -d $KANI_DIR/docs/book/rfc
# doc tests is in README.md. We don't run them here because
# that would cause CI to run these tests twice.

echo "Building rustdocs..."
cd $KANI_DIR
cargo doc -p kani -p kani_macros --no-deps --target-dir docs/book/crates

echo "Finished documentation build successfully."