rust/doc
Brian Anderson ce95b01014 Disable linked failure tests
The implementation currently contains a race that leads to segfaults.
2013-08-07 16:32:20 -07:00
..
lib Remove fail keyword from lexer & parser and clean up remaining calls to 2013-02-01 00:15:42 -08:00
po remove obsolete foreach keyword 2013-08-03 22:48:02 -04:00
lib.css Establish 'core' library separate from 'std'. 2011-12-06 12:13:04 -08:00
manual.css Display the full TOC in the manual. Closes #4194 2012-12-14 18:06:21 -08:00
po4a.conf Use po4a to provide translatable documentation 2013-07-07 21:12:00 +02:00
prep.js fix escape 2012-10-05 12:41:00 -07:00
README Usable instructions for generating docs from source 2013-06-21 00:56:43 -04:00
rust.css Remove h[123] border and increase their padding to better readability 2013-06-16 17:40:45 +02:00
rust.md remove obsolete foreach keyword 2013-08-03 22:48:02 -04:00
rustpkg.md docs: Talk about tags that aren't versions in the "Package identifiers" section 2013-07-26 20:06:41 -07:00
tutorial-borrowed-ptr.md fix text of tutorials 2013-06-21 00:53:10 -04:00
tutorial-container.md make for parse as foreach does 2013-08-03 03:00:42 -04:00
tutorial-ffi.md librustc: Disallow "mut" from distributing over bindings. 2013-06-28 10:44:15 -04:00
tutorial-macros.md librustc: Disallow multiple patterns from appearing in a "let" declaration. 2013-06-04 21:45:42 -07:00
tutorial-tasks.md Disable linked failure tests 2013-08-07 16:32:20 -07:00
tutorial.md remove extra::iter 2013-08-06 23:41:20 -04:00
version_info.html.template add gitattributes and fix whitespace issues 2013-05-03 20:01:42 -04:00

Pandoc, a universal document converter, is required to generate docs as HTML
from Rust's source code. It's available for most platforms here:
http://johnmacfarlane.net/pandoc/installing.html

Node.js (http://nodejs.org/) is also required for generating HTML from
the Markdown docs (reference manual, tutorials, etc.) distributed with
this git repository.

To generate all the docs, 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-dir html-doc/ --output-format html ../src/libstd/path.rs

(This, of course, requires that you've built/installed the `rustdoc` tool.)

To generate an HTML version of a doc from Markdown, without having Node.js
installed, do something like:

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

The syntax for pandoc flavored markdown can be found at:
http://johnmacfarlane.net/pandoc/README.html#pandocs-markdown

A nice quick reference (for non-pandoc markdown) is at:
http://kramdown.rubyforge.org/quickref.html