Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 2 additions & 2 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -41,5 +41,5 @@ test-ledger
*.txt
*.log

doc
tmp.ps1
#doc
doc
18 changes: 18 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,24 @@ cargo dv clean --targets aster_common

You can also run `cargo dv clean` to clean all artifacts at once.

#### Documentation

We provide comprehensive API-level documentation that describes the verified APIs along with their auxiliary lemmas. To generate the documentation, run:

```
cargo dv doc --target ostd
```

The generated documentation can be found at `doc/index.html`.

If you are interested in the precise Verus definitions, you can run:

```
cargo dv doc --target ostd --verus-conds
```

This will additionally include the Verus specifications and the pre- and post-conditions for each function.

#### IDE Support

For VSCode users, the [`verus-analyzer`](https://marketplace.visualstudio.com/items?itemName=verus-lang.verus-analyzer) extension is available in the Marketplace.
Expand Down
2 changes: 1 addition & 1 deletion dv
Submodule dv updated 6 files
+0 −1 src/dep_tree.rs
+167 −0 src/doc.rs
+0 −1 src/generator.rs
+1 −0 src/lib.rs
+13 −8 src/main.rs
+44 −9 src/verus.rs