File tree Expand file tree Collapse file tree 2 files changed +5
-14
lines changed Expand file tree Collapse file tree 2 files changed +5
-14
lines changed Original file line number Diff line number Diff line change @@ -23,7 +23,7 @@ refs/tags/0.9: 36870b185fc5f5486636d4515f0e22677493f225
23
23
refs/tags/0.10: ac33f2b15782272ae348dbd7b14b8257b2148b5a
24
24
refs/tags/0.11.0: e1247cb1d0d681be034adb4b558b5a0c0d5720f9
25
25
refs/tags/0.12.0: f0c419429ef30723ceaf6b42f9b5a2aeb5d2e2d1
26
- refs/heads/beta: 09ed80fc9cb61cb9e38f0fdd9a91effb933b77b2
26
+ refs/heads/beta: 75f7a68ffa2b8ff0a9292d3d751fc4f28c074f72
27
27
refs/tags/1.0.0-alpha: e42bd6d93a1d3433c486200587f8f9e12590a4d7
28
28
refs/heads/tmp: 370fe2786109360f7c35b8ba552b83b773dd71d6
29
29
refs/tags/1.0.0-alpha.2: 4c705f6bc559886632d3871b04f58aab093bfa2f
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