diff options
| author | Philipp A | 2020-01-08 20:13:56 +0100 |
|---|---|---|
| committer | Philipp A | 2020-01-08 20:13:56 +0100 |
| commit | 2634a083a58e15935ce57eb0077f736309e78aae (patch) | |
| tree | 73324f7255a960218e3648ce1b8703ac7af7b45a /parser | |
| parent | 06e7d81088e33d7ee03e7088e1ec2289e9c2bf5c (diff) | |
| download | rust-rst-2634a083a58e15935ce57eb0077f736309e78aae.tar.bz2 | |
Added READMEs
Diffstat (limited to 'parser')
| -rw-r--r-- | parser/Cargo.toml | 5 | ||||
| -rw-r--r-- | parser/README.md | 9 |
2 files changed, 12 insertions, 2 deletions
diff --git a/parser/Cargo.toml b/parser/Cargo.toml index a423fbe..f208f22 100644 --- a/parser/Cargo.toml +++ b/parser/Cargo.toml @@ -5,10 +5,11 @@ authors = ['Philipp A. <flying-sheep@web.de>'] edition = '2018' description = 'a reStructuredText parser' license = 'MIT OR Apache-2.0' +readme = 'README.md' -documentation = 'https://flying-sheep.github.io/rust-rst' +documentation = 'https://docs.rs/rst_parser' homepage = 'https://github.com/flying-sheep/rust-rst' -repository = 'https://github.com/flying-sheep/rust-rst.git' +repository = 'https://github.com/flying-sheep/rust-rst' [dependencies] document_tree = { path = '../document_tree', version = '0.3.0' } diff --git a/parser/README.md b/parser/README.md new file mode 100644 index 0000000..81d3d16 --- /dev/null +++ b/parser/README.md @@ -0,0 +1,9 @@ +`rst_parser` +============ + +Part of the [`rst`][rst] crate family. +Offers the functions `parse` and `parse_only`, +which try to create a `document_tree::Document`. +`parse` simplifies this document and resolves references before returning it. + +[rst]: https://github.com/flying-sheep/rust-rst/#readme |