rust/src/doc
Masaki Hara a0c422a752 Remove a now-unnecessary paragraph.
The paragraph described a case where we can't optimize away repetitive
dynamic stack allocation. However, as arielb1 pointed out, it can
actually optimizable by dynamically delaying the stack unwinding.
2018-08-19 08:07:33 +09:00
..
book@88cdde350f update books for new release 2018-07-30 11:09:48 -04:00
man Remove references to AUTHORS.txt file 2018-07-30 07:47:12 +02:00
nomicon@790e96b87f update books for new release 2018-07-30 11:09:48 -04:00
reference@219e261ddb update books for new release 2018-07-30 11:09:48 -04:00
rust-by-example@e3719fc78f update books for new release 2018-07-30 11:09:48 -04:00
rustc Fix naming conventions for new lints 2018-05-25 02:35:07 +03:00
rustdoc Fix links in rustdoc book. 2018-07-18 21:10:25 -07:00
unstable-book Remove a now-unnecessary paragraph. 2018-08-19 08:07:33 +09:00
complement-design-faq.md
complement-lang-faq.md
complement-project-faq.md
favicon.inc
footer.inc
full-toc.inc
grammar.md Rollup merge of #50791 - bstrie:null, r=QuietMisdreavus 2018-05-17 13:51:25 -06: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 update doc index to link to the rustc book 2018-04-09 14:04:57 -04:00
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
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 Rename trans to codegen everywhere. 2018-05-17 15:08:30 +03:00
rustdoc.md
tutorial.md Update tutorial.md 2018-05-17 12:25:24 -07:00
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.