File tree 3 files changed +20
-0
lines changed
3 files changed +20
-0
lines changed Original file line number Diff line number Diff line change 34
34
- [ Intrinsics] ( ./rust-feature-support/intrinsics.md )
35
35
- [ Unstable features] ( ./rust-feature-support/unstable.md )
36
36
- [ Overrides] ( ./overrides.md )
37
+
38
+ - [ Crates Documentation] ( ./crates/index.md )
Original file line number Diff line number Diff line change
1
+ # Crates documentation
2
+
3
+ Kani currently ships with a couple crates that provide APIs to allow users to
4
+ write and configure their harnesses.
5
+ These APIs are tightly coupled with each Kani version, so they are not
6
+ published yet at <crates.io>.
7
+
8
+ You can find their latest documentation here:
9
+ - [ kani] ( https://model-checking.github.io/kani/crates/kani ) : This crate
10
+ provide APIs to write Kani harnesses.
11
+ - [ kani_macros] ( https://model-checking.github.io/kani/crates/kani_macros ) :
12
+ This crate provides ` proc_macro ` definitions that allow users to configure their
13
+ harnesses using function attributes.
14
+
Original file line number Diff line number Diff line change @@ -65,4 +65,8 @@ $SCRIPT_DIR/mdbook build -d $KANI_DIR/docs/book/rfc
65
65
# doc tests is in README.md. We don't run them here because
66
66
# that would cause CI to run these tests twice.
67
67
68
+ echo " Building rustdocs..."
69
+ cd $KANI_DIR
70
+ cargo doc -p kani -p kani_macros --no-deps --target-dir docs/book/crates
71
+
68
72
echo " Finished documentation build successfully."
You can’t perform that action at this time.
0 commit comments