Crate cargo_readme [−] [src]

Create README.md content from rust doc comments

Modules

Read crate information from Cargo.toml

Functions

generate_readme

Generates readme data from source file

Keyboard Shortcuts

?: Show this help dialog
S: Focus the search field
⇤: Move up in search results
⇥: Move down in search results
⏎: Go to active search result
+: Collapse/expand all sections

Search Tricks

Prefix searches with a type followed by a colon (e.g. fn:) to restrict the search to a given type.

Accepted types are: fn, mod, struct, enum, trait, type, macro, and const.

Search functions by type signature (e.g. vec -> usize or * -> vec)