Skip to content

Files

This branch is 227648 commits behind rust-lang/rust:master.

doc

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
Feb 3, 2017
Feb 2, 2017
Apr 19, 2016
Dec 23, 2015
Dec 23, 2015
Dec 23, 2015
Aug 9, 2015
Oct 15, 2016
Apr 19, 2014
Jan 10, 2017
Jan 17, 2015
Jan 17, 2015
Jan 17, 2015
Jan 17, 2015
Jan 17, 2015
Mar 8, 2016
Jun 29, 2015
Jan 17, 2015
Mar 4, 2015
Jan 17, 2015
Jan 17, 2015
Jan 17, 2015
Nov 17, 2016
Apr 18, 2015
Aug 9, 2015
Jan 22, 2017
Dec 4, 2016
Sep 22, 2014
Jun 20, 2016
Jan 21, 2015
Jan 14, 2015
Jan 20, 2016

Rust documentations

Building

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.

To generate HTML documentation from one source file/crate, do something like:

rustdoc --output html-doc/ --output-format html ../src/libstd/path.rs

(This, of course, requires a working build of the rustdoc tool.)

Additional notes

To generate an HTML version of a doc from Markdown manually, you can do something like:

rustdoc reference.md

(reference.md being the Rust Reference Manual.)

An overview of how to use the rustdoc command is available in the docs. Further details are available from the command line by with rustdoc --help.