2014-09-25 09:11:18 -05:00
|
|
|
# Rust documentations
|
|
|
|
|
|
|
|
## Building
|
2014-01-11 08:19:38 -06:00
|
|
|
|
2015-09-26 14:03:42 -05:00
|
|
|
To generate all the docs, follow the "Building Documentation" instructions in
|
|
|
|
the README in the root of the repository. This will convert the distributed
|
|
|
|
Markdown docs to HTML and generate HTML doc for the books, 'std' and 'extra'
|
|
|
|
libraries.
|
2014-01-11 08:19:38 -06:00
|
|
|
|
|
|
|
To generate HTML documentation from one source file/crate, do something like:
|
|
|
|
|
2016-04-14 20:00:35 -05:00
|
|
|
~~~~text
|
2014-08-17 14:37:51 -05:00
|
|
|
rustdoc --output html-doc/ --output-format html ../src/libstd/path.rs
|
2014-01-11 08:19:38 -06:00
|
|
|
~~~~
|
|
|
|
|
|
|
|
(This, of course, requires a working build of the `rustdoc` tool.)
|
|
|
|
|
2014-09-25 09:11:18 -05:00
|
|
|
## Additional notes
|
2014-01-11 08:19:38 -06:00
|
|
|
|
2014-03-09 05:06:03 -05:00
|
|
|
To generate an HTML version of a doc from Markdown manually, you can do
|
|
|
|
something like:
|
2014-01-11 08:19:38 -06:00
|
|
|
|
2016-04-14 20:00:35 -05:00
|
|
|
~~~~text
|
2015-08-11 19:12:31 -05:00
|
|
|
rustdoc reference.md
|
2014-01-11 08:19:38 -06:00
|
|
|
~~~~
|
|
|
|
|
2014-09-25 09:11:18 -05:00
|
|
|
(`reference.md` being the Rust Reference Manual.)
|
2014-01-11 08:19:38 -06:00
|
|
|
|
2015-08-11 19:12:31 -05:00
|
|
|
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`.
|
2014-01-13 00:18:04 -06:00
|
|
|
|
2015-11-30 14:00:30 -06:00
|
|
|
[1]: https://github.com/rust-lang/rust/blob/master/src/doc/book/documentation.md
|