Manish Goregaokar 67b51291f0 Rollup merge of #21925 - sfackler:allow-missing-copy, r=alexcrichton
This was particularly helpful in the time just after OIBIT's
implementation to make sure things that were supposed to be Copy
continued to be, but it's now creates a lot of noise for types that
intentionally don't want to be Copy.

r? @alexcrichton
2015-02-06 16:21:08 +05:30
..
2015-01-14 16:13:58 -08:00
2015-01-07 09:23:31 -05:00
2015-01-29 15:49:00 -08:00
2015-01-31 17:40:40 +01:00
2015-01-12 13:16:07 -05:00
2015-01-21 14:59:25 -05:00
2015-01-13 21:11:47 -05:00

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: