Skip to content

Add doc command#14

Merged
rikosellic merged 3 commits intoasterinas:mainfrom
rikosellic:doc-command
Jan 7, 2026
Merged

Add doc command#14
rikosellic merged 3 commits intoasterinas:mainfrom
rikosellic:doc-command

Conversation

@rikosellic
Copy link
Collaborator

@rikosellic rikosellic commented Jan 7, 2026

This PR adds cargo dv doc, which has two options:

  • --target: This one is compulsory, stating the crate to be generated, its dependencies' docs will be generated as well (although not as pretty as cargo doc).
  • --verus-conds: Whether to include Verus pre/post-conditions. Disabled by default.

You can run, for example, cargo dv doc --target ostd, and you can access it with doc/index.html.

@rikosellic rikosellic merged commit f008182 into asterinas:main Jan 7, 2026
1 check passed
@rikosellic rikosellic deleted the doc-command branch January 7, 2026 09:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant