Extract data from Markdown as used in Rust documentation strings
APACHE-2.0 License
This is a proof of concept.
This Rust library can be used to extract some data from documentation formatted as described here.
Rendered Documentation of master branch.
For example, given a string like this one:
Lorem ipsum
A longer description lorem ipsum dolor sit amet.
# Parameters
- `param1`: Foo
- `param2`: Bar
it will return structure like this:
DocBlock {
teaser: "Lorem ipsum",
description: Some("A longer description lorem ipsum dolor sit amet."),
sections: [
Parameters([
("param1", "Foo"),
("param2", "Bar")
])
]
}
Licensed under either of
at your option.
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.