rust/src/doc
2018-04-16 16:25:57 +09:00
..
book@b889e1e30c update books for next release 2018-03-24 15:31:02 +01:00
man Implement --remap-path-prefix 2018-02-22 15:13:21 -08:00
nomicon@3c56329d1b Rename alloc::Void to alloc::Opaque 2018-04-12 22:53:22 +02:00
reference@76296346e9 update books for next release 2018-03-24 15:31:02 +01:00
rust-by-example@d5ec87eabe update books for next release 2018-03-24 15:31:02 +01:00
rustdoc Remove unnecessary indentation in rustdoc book codeblock. 2018-04-16 16:25:57 +09:00
unstable-book Replace remaining uses of deprecated std::heap with std::alloc 2018-04-14 16:47:38 +09:00
complement-design-faq.md
complement-lang-faq.md
complement-project-faq.md
favicon.inc
footer.inc
full-toc.inc
grammar.md Add _ to the list of keywords 2017-06-17 13:14:26 -07:00
guide-crates.md
guide-error-handling.md
guide-ffi.md
guide-macros.md
guide-ownership.md
guide-plugins.md Add top level sections to the Unstable Book. 2017-04-18 21:26:09 -04:00
guide-pointers.md
guide-strings.md
guide-tasks.md
guide-testing.md
guide-unsafe.md
guide.md
index.md Using X headings instead of 0.X #49739 2018-04-07 00:42:47 +05:30
intro.md
not_found.md fix markdown file differences 2017-12-07 23:56:21 +01:00
README.md fix for documentation error issue 47716 2018-01-24 09:25:46 -07:00
reference.md Redirect to the new reference 2017-02-21 14:03:13 -05:00
rust.css Fix error index display 2018-01-09 22:26:26 +01:00
rust.md Avoid linking to a moved page in rust.html 2017-03-29 15:38:47 +02:00
rustc-ux-guidelines.md Move librustc_const_eval to librustc_mir 2018-03-08 08:08:14 +01:00
rustdoc.md
tutorial.md
version_info.html.template

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.