]> git.lizzy.rs Git - rust.git/commitdiff
doc/readme: replace references to Pandoc with rustdoc.
authorChris Krycho <chris@krycho.com>
Wed, 12 Aug 2015 00:12:31 +0000 (20:12 -0400)
committerChris Krycho <chris@krycho.com>
Thu, 13 Aug 2015 02:29:05 +0000 (22:29 -0400)
src/doc/README.md

index 3b12ffe8f11e1bf25151fe09760763ef079960ad..c09f28ae4f62d5cc0dd594505f39d0e50bec19ca 100644 (file)
@@ -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:
-
-- http://johnmacfarlane.net/pandoc/README.html#pandocs-markdown
-
-A nice quick reference (for non-pandoc markdown) is 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://kramdown.gettalong.org/quickref.html
+[1]: https://github.com/rust-lang/rust/blob/master/src/doc/trpl/documentation.md