cargo-readme
cargo-readme copied to clipboard
webern
Generate README.md from docstrings
A code block like ``` # use foo::bar; # bar() ``` Produces ``` # bar() ```
Using `/*! */` and `//! ` is basically just syntactic sugar for a `#![doc = r#""#]` attribute. However, cargo-readme does not currently parse those attributes, and generates an empty readme...
The following doc comment: ``````rust //! //! This crate frequently uses a trait bound like the following where subprocess //! commands are required: //! //! ```none,actually-rust-but-see-https://github.com/rust-lang/rust/issues/63193 //! T where //!...
[`document-features`](https://crates.io/crates/document-features) is a crate that, like `cargo-readme`, tries to minimize copypasta for developers. In this case, comments in the `[features]` section of a crate's `Cargo.toml` get used to populate a...
I added a `--quote-title` flag since I and some other crate authors like to have their crate title as # `foo` rather than # foo This includes a test for...
My project uses `#![doc = include_str!("../README.md")]` to generate the rustdoc for the crate from its README. However, I noticed a user forked it just to remove this line, ostensibly since...
[Intra-doc links](http://rust-lang.github.io/rfcs/1946-intra-rustdoc-links.html) allow documentation authors to link to items by their path relative to the current module. It would be nice to resolve intra-doc links in the same way that...
When I try to use `cargo readme` in a workspace directory I get this error: > Error: missing field `path` for key `lib` at line 23 column 1 I have...
