0e57709161
Update the book submodule and fix tidy When the book was included into https://github.com/rust-lang/rust as a submodule, tidy started failing on Windows. https://github.com/rust-lang/book/pull/549 fixed the problem, now the submodule needs to be updated.
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
.