Skip to content

Commit 438e582

Browse files
celinvaladpaco-aws
andauthored
Publish our crates documentation (rust-lang#1994)
Co-authored-by: Adrian Palacios <[email protected]>
1 parent 71b9d0e commit 438e582

File tree

3 files changed

+20
-0
lines changed

3 files changed

+20
-0
lines changed

docs/src/SUMMARY.md

+2
Original file line numberDiff line numberDiff line change
@@ -34,3 +34,5 @@
3434
- [Intrinsics](./rust-feature-support/intrinsics.md)
3535
- [Unstable features](./rust-feature-support/unstable.md)
3636
- [Overrides](./overrides.md)
37+
38+
- [Crates Documentation](./crates/index.md)

docs/src/crates/index.md

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
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+

scripts/build-docs.sh

+4
Original file line numberDiff line numberDiff line change
@@ -65,4 +65,8 @@ $SCRIPT_DIR/mdbook build -d $KANI_DIR/docs/book/rfc
6565
# doc tests is in README.md. We don't run them here because
6666
# that would cause CI to run these tests twice.
6767

68+
echo "Building rustdocs..."
69+
cd $KANI_DIR
70+
cargo doc -p kani -p kani_macros --no-deps --target-dir docs/book/crates
71+
6872
echo "Finished documentation build successfully."

0 commit comments

Comments
 (0)