From 75f7a68ffa2b8ff0a9292d3d751fc4f28c074f72 Mon Sep 17 00:00:00 2001 From: Chris Krycho Date: Tue, 11 Aug 2015 20:12:31 -0400 Subject: [PATCH] doc/readme: replace references to Pandoc with rustdoc. --- src/doc/README.md | 17 ++++------------- 1 file changed, 4 insertions(+), 13 deletions(-) diff --git a/src/doc/README.md b/src/doc/README.md index 3b12ffe8f11e..c09f28ae4f62 100644 --- a/src/doc/README.md +++ b/src/doc/README.md @@ -1,11 +1,5 @@ # Rust documentations -## Dependencies - -[Pandoc](http://johnmacfarlane.net/pandoc/installing.html), a universal -document converter, is required to generate docs as HTML from Rust's -source code. - ## Building To generate all the docs, just run `make docs` from the root of the repository. @@ -26,15 +20,12 @@ To generate an HTML version of a doc from Markdown manually, you can do something like: ~~~~ -pandoc --from=markdown --to=html5 --number-sections -o reference.html reference.md +rustdoc reference.md ~~~~ (`reference.md` being the Rust Reference Manual.) -The syntax for pandoc flavored markdown can be found at: +An overview of how to use the `rustdoc` command is available [in the docs][1]. +Further details are available from the command line by with `rustdoc --help`. -- http://johnmacfarlane.net/pandoc/README.html#pandocs-markdown - -A nice quick reference (for non-pandoc markdown) is at: - -- http://kramdown.gettalong.org/quickref.html +[1]: https://github.com/rust-lang/rust/blob/master/src/doc/trpl/documentation.md