rust/src/doc
kennytm b443e57ce6
Rollup merge of #48166 - hedgehog1024:hedgehog1024-stabilize-entry_and_modify, r=alexcrichton
Stabilize 'entry_and_modify' feature

Stabilize `entry_and_modify` feature introduced by #44734.

Closes #44733
2018-02-25 15:54:42 +08:00
..
book@98921e9de8 Update the book to promote second edition 2018-02-21 14:26:09 -05:00
man template month/year, version into man pages while building dist tarball 2017-12-04 23:47:59 -08:00
nomicon@ad5ddd62c0 Update books for next release 2018-02-09 11:27:47 -07:00
reference@254df654a9 Update books for next release 2018-02-09 11:27:47 -07:00
rust-by-example@ebb28c95b2 Update to last repository version 2018-02-17 16:31:07 +01:00
rustdoc Reexport -> re-export in documentation section headings 2018-01-15 13:36:52 -05:00
unstable-book Rollup merge of #48166 - hedgehog1024:hedgehog1024-stabilize-entry_and_modify, r=alexcrichton 2018-02-25 15:54:42 +08: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
guide-pointers.md
guide-strings.md
guide-tasks.md
guide-testing.md
guide-unsafe.md
guide.md
index.md add Rust By Example to the bookshelf 2018-01-16 19:35:39 -06: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
rustc-ux-guidelines.md
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.