rust/src/doc
Ulrik Sverdrup f4fac9b0fa Fix spacing style of T: Bound in docs
The space between `T` and `Bound` is the typical style used in code and
produced by rustdoc's rendering. Fixed first in Reflect's docs and then
I fixed all occurrences in docs I could find.
2016-01-17 23:44:33 +01:00
..
book Fix spacing style of T: Bound in docs 2016-01-17 23:44:33 +01:00
nomicon Fix spacing style of T: Bound in docs 2016-01-17 23:44:33 +01:00
style Fix double word 'be' 2015-11-08 09:39:01 -06:00
complement-design-faq.md Remove the FAQs in favor of the website 2015-12-23 14:03:45 -08:00
complement-lang-faq.md Remove the FAQs in favor of the website 2015-12-23 14:03:45 -08:00
complement-project-faq.md Remove the FAQs in favor of the website 2015-12-23 14:03:45 -08:00
favicon.inc
footer.inc
full-toc.inc
grammar.md Allow bare semicolon in grammar doc, closes 2015-10-24 00:45:18 +02: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 doc: Add descriptions to links in the index 2016-01-10 22:30:09 +00:00
intro.md
not_found.md
README.md Fix path to TRPL in doc README 2015-11-30 15:00:30 -05:00
reference.md Auto merge of - steffengy:master, r=alexcrichton 2016-01-16 23:30:30 +00:00
rust.css Update the playpen link for code in the rust book to agree with rustdoc's new style 2015-10-25 16:18:55 -04:00
rust.md
rustc-ux-guidelines.md Add rustc UX guidelines. 2015-11-08 13:23:18 +00:00
rustdoc.md
tutorial.md
uptack.tex
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.