Skip to content

Commit 75f7a68

Browse files
committed
doc/readme: replace references to Pandoc with rustdoc.
1 parent 09ed80f commit 75f7a68

File tree

1 file changed

+4
-13
lines changed

1 file changed

+4
-13
lines changed

src/doc/README.md

Lines changed: 4 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,5 @@
11
# Rust documentations
22

3-
## Dependencies
4-
5-
[Pandoc](http://johnmacfarlane.net/pandoc/installing.html), a universal
6-
document converter, is required to generate docs as HTML from Rust's
7-
source code.
8-
93
## Building
104

115
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
2620
something like:
2721

2822
~~~~
29-
pandoc --from=markdown --to=html5 --number-sections -o reference.html reference.md
23+
rustdoc reference.md
3024
~~~~
3125

3226
(`reference.md` being the Rust Reference Manual.)
3327

34-
The syntax for pandoc flavored markdown can be found at:
35-
36-
- http://johnmacfarlane.net/pandoc/README.html#pandocs-markdown
37-
38-
A nice quick reference (for non-pandoc markdown) is at:
28+
An overview of how to use the `rustdoc` command is available [in the docs][1].
29+
Further details are available from the command line by with `rustdoc --help`.
3930

40-
- http://kramdown.gettalong.org/quickref.html
31+
[1]: https://github.com/rust-lang/rust/blob/master/src/doc/trpl/documentation.md

0 commit comments

Comments
 (0)