rust/doc
2013-09-24 01:06:02 -07:00
..
lib
po Update version numbers to 0.8 2013-09-21 16:25:08 -07:00
lib.css
manual.css
po4a.conf
prep.js
README
rust.css
rust.md Invert --cfg debug to --cfg ndebug 2013-09-20 12:10:04 -07:00
rustpkg.md
tutorial-borrowed-ptr.md
tutorial-conditions.md Remove {uint,int,u64,i64,...}::from_str,from_str_radix 2013-09-15 14:29:16 +02:00
tutorial-container.md doc: Update container tutorial with new names of methods and macros 2013-09-18 23:17:07 -04:00
tutorial-ffi.md switch Drop to &mut self 2013-09-16 22:19:23 -04:00
tutorial-macros.md
tutorial-rustpkg.md Add rustpkg tutorial to the official tutorials. 2013-09-23 14:36:38 -07:00
tutorial-tasks.md Fix signature of Result in tasks tutorial. Closes #8343 2013-09-23 22:30:42 -04:00
tutorial.md auto merge of #9439 : steveklabnik/rust/build_rustpkg_tutorial, r=brson 2013-09-23 22:26:06 -07:00
version_info.html.template

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