rust/src/doc
Alex Crichton 7fcc330ea3 rollup merge of #22007: thiagooak/master
From #21829 clarify equivalency of tuples
2015-02-10 08:41:38 -08:00
..
trpl rollup merge of #22007: thiagooak/master 2015-02-10 08:41:38 -08:00
complement-bugreport.md Update complement-bugreport.md 2014-12-22 19:43:57 -05:00
complement-design-faq.md doc: small grammar fix 2014-11-15 23:17:36 +00:00
complement-lang-faq.md doc: fix links to servo 2015-01-14 16:13:58 -08:00
complement-project-faq.md doc: fix links to servo 2015-01-14 16:13:58 -08:00
favicon.inc
footer.inc Bump copyright year in doc footer 2015-01-07 09:23:31 -05:00
full-toc.inc
grammar.md Replace be with become 2015-02-04 01:25:24 +01:00
guide-crates.md Grammar tweak to old guide stub documents. 2015-01-16 22:25:22 -05:00
guide-error-handling.md Grammar tweak to old guide stub documents. 2015-01-16 22:25:22 -05:00
guide-ffi.md Grammar tweak to old guide stub documents. 2015-01-16 22:25:22 -05:00
guide-macros.md Grammar tweak to old guide stub documents. 2015-01-16 22:25:22 -05:00
guide-ownership.md Grammar tweak to old guide stub documents. 2015-01-16 22:25:22 -05:00
guide-plugins.md Grammar tweak to old guide stub documents. 2015-01-16 22:25:22 -05:00
guide-pointers.md Grammar tweak to old guide stub documents. 2015-01-16 22:25:22 -05:00
guide-strings.md Grammar tweak to old guide stub documents. 2015-01-16 22:25:22 -05:00
guide-tasks.md Grammar tweak to old guide stub documents. 2015-01-16 22:25:22 -05:00
guide-testing.md Grammar tweak to old guide stub documents. 2015-01-16 22:25:22 -05:00
guide-unsafe.md Grammar tweak to old guide stub documents. 2015-01-16 22:25:22 -05:00
guide.md Grammar tweak to old guide stub documents. 2015-01-16 22:25:22 -05:00
index.md doc: Add links to users.rust-lang.org 2015-01-29 15:49:00 -08:00
intro.md Kill more isizes 2015-01-31 17:40:40 +01:00
not_found.md Remove PDF link on 404 page 2015-01-12 13:16:07 -05:00
README.md remove l10n 2014-12-17 21:00:04 -05:00
reference.md rollup merge of #21918: ranma42/replace-be 2015-02-10 08:41:30 -08:00
rust.css Improve Rust Documentation & Reference on mobile 2015-01-13 22:39:52 -08:00
rust.md
rustdoc.md Move rustdoc.md into the book 2015-01-21 14:59:25 -05:00
tutorial.md Re-direct to the right place. 2015-01-13 21:11:47 -05:00
uptack.tex Changed LaTex $\bot$s to ⊥ 2014-12-19 18:09:33 -05:00
version_info.html.template

Rust documentations

Dependencies

Pandoc, a universal document converter, is required to generate docs as HTML from Rust's source code.

Building

To generate all the docs, just run make docs from the root of the repository. This will convert the distributed Markdown docs to HTML and generate HTML doc for the '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:

pandoc --from=markdown --to=html5 --number-sections -o reference.html reference.md

(reference.md being the Rust Reference Manual.)

The syntax for pandoc flavored markdown can be found at:

A nice quick reference (for non-pandoc markdown) is at: