File tree 1 file changed +4
-13
lines changed 1 file changed +4
-13
lines changed Original file line number Diff line number Diff line change 1
1
# Rust documentations
2
2
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
-
9
3
## Building
10
4
11
5
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
26
20
something like:
27
21
28
22
~~~~
29
- pandoc --from=markdown --to=html5 --number-sections -o reference.html reference.md
23
+ rustdoc reference.md
30
24
~~~~
31
25
32
26
(` reference.md ` being the Rust Reference Manual.)
33
27
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 ` .
39
30
40
- - http ://kramdown.gettalong.org/quickref.html
31
+ [ 1 ] : https ://github.com/rust-lang/rust/blob/master/src/doc/trpl/documentation.md
You can’t perform that action at this time.
0 commit comments