about summary refs log tree commit diff
diff options
context:
space:
mode:
authorChris Krycho <chris@krycho.com>2015-08-11 20:12:31 -0400
committerChris Krycho <chris@krycho.com>2015-08-12 22:29:05 -0400
commit75f7a68ffa2b8ff0a9292d3d751fc4f28c074f72 (patch)
tree4e9caba46f69f70a61428655526c4da48040a445
parent09ed80fc9cb61cb9e38f0fdd9a91effb933b77b2 (diff)
downloadrust-75f7a68ffa2b8ff0a9292d3d751fc4f28c074f72.tar.gz
rust-75f7a68ffa2b8ff0a9292d3d751fc4f28c074f72.zip
doc/readme: replace references to Pandoc with rustdoc.
-rw-r--r--src/doc/README.md17
1 files changed, 4 insertions, 13 deletions
diff --git a/src/doc/README.md b/src/doc/README.md
index 3b12ffe8f11..c09f28ae4f6 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:
-
-- 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