rust/src/doc
2015-05-13 20:03:56 -07:00
..
style Fix invalid references due to the automated string substitution 2015-05-09 02:24:18 +09:00
trpl Fix table syntax. 2015-05-13 20:03:56 -07:00
complement-design-faq.md Squeeze the last bits of tasks in documentation in favor of thread 2015-05-09 02:24:18 +09:00
complement-lang-faq.md Squeeze the last bits of tasks in documentation in favor of thread 2015-05-09 02:24:18 +09:00
complement-project-faq.md
favicon.inc
footer.inc
full-toc.inc
grammar.md Overwrite grammar sections with what was removed from the reference 2015-05-10 22:47:39 -04: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 Rollup merge of #25331 - michaelsproul:err-idx-doc-link, r=Manishearth 2015-05-12 22:57:53 +05:30
intro.md Remove the 30 minute intro 2015-04-18 17:55:31 -04:00
not_found.md Fix #24872, XSS in docs not found page. 2015-04-28 13:31:45 +10:00
README.md
reference.md Fix test failure in the reference 2015-05-13 17:53:57 -04:00
rust.css
rust.md
rustdoc.md
tutorial.md
uptack.tex
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: