]>
Commit | Line | Data |
---|---|---|
1a4d82fc JJ |
1 | # Rust documentations |
2 | ||
1a4d82fc JJ |
3 | ## Building |
4 | ||
b039eaaf SL |
5 | To generate all the docs, follow the "Building Documentation" instructions in |
6 | the README in the root of the repository. This will convert the distributed | |
7 | Markdown docs to HTML and generate HTML doc for the books, 'std' and 'extra' | |
8 | libraries. | |
1a4d82fc JJ |
9 | |
10 | To generate HTML documentation from one source file/crate, do something like: | |
11 | ||
12 | ~~~~ | |
13 | rustdoc --output html-doc/ --output-format html ../src/libstd/path.rs | |
14 | ~~~~ | |
15 | ||
16 | (This, of course, requires a working build of the `rustdoc` tool.) | |
17 | ||
18 | ## Additional notes | |
19 | ||
20 | To generate an HTML version of a doc from Markdown manually, you can do | |
21 | something like: | |
22 | ||
23 | ~~~~ | |
e9174d1e | 24 | rustdoc reference.md |
1a4d82fc JJ |
25 | ~~~~ |
26 | ||
27 | (`reference.md` being the Rust Reference Manual.) | |
28 | ||
e9174d1e SL |
29 | An overview of how to use the `rustdoc` command is available [in the docs][1]. |
30 | Further details are available from the command line by with `rustdoc --help`. | |
1a4d82fc | 31 | |
92a42be0 | 32 | [1]: https://github.com/rust-lang/rust/blob/master/src/doc/book/documentation.md |