Skip to content

Files

This branch is 259230 commits behind rust-lang/rust:master.

doc

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
Feb 1, 2013
Nov 26, 2013
Oct 19, 2013
Nov 13, 2013
Nov 13, 2013
Aug 12, 2013
Oct 5, 2012
Nov 13, 2013
Nov 26, 2013
Nov 14, 2013
Oct 1, 2013
Nov 26, 2013
Nov 18, 2013
Nov 14, 2013
Nov 18, 2013
Nov 13, 2013
Nov 25, 2013
Nov 26, 2013
Oct 19, 2013
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=html5 --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