rust/doc
2013-11-03 17:31:20 -08:00
..
lib Remove fail keyword from lexer & parser and clean up remaining calls to 2013-02-01 00:15:42 -08:00
po doc (en & ja): remove mentions of type float, rust and rusti tools 2013-10-20 01:00:22 +02:00
manual.inc doc: tidy and cleanup CSS deps, add tutorial PDF generation 2013-10-21 04:12:12 +02:00
po4a.conf doc: Generate .po files for Japanse translations 2013-08-12 22:39:31 +09:00
prep.js fix escape 2012-10-05 12:41:00 -07:00
README doc: switch pandoc to html5 2013-10-19 20:29:34 +02:00
rust.css doc: expand tutorial/manual CSS 2013-10-21 04:12:58 +02:00
rust.md docs: Replace std::iterator with std::iter. 2013-11-04 10:01:00 +11:00
rustpkg.md rustpkg: Make checked-out source files read-only, and overhaul where temporary files are stored 2013-10-10 15:16:31 -07:00
tutorial-borrowed-ptr.md remove the float type 2013-10-01 14:54:10 -04:00
tutorial-conditions.md Test fixes and merge conflicts 2013-10-24 14:21:58 -07:00
tutorial-container.md docs: Replace std::iterator with std::iter. 2013-11-04 10:01:00 +11:00
tutorial-ffi.md std: Move size/align functions to std::mem. #2240 2013-10-17 17:31:35 -07:00
tutorial-macros.md Remove old logging from the tutorial 2013-10-22 08:10:34 -07:00
tutorial-rustpkg.md docs / rustpkg: Document rustpkg test more 2013-10-05 23:17:23 -04:00
tutorial-tasks.md Test fixes and merge conflicts 2013-10-24 14:21:58 -07:00
tutorial.md Fixed formatting. 2013-11-03 22:44:15 +05:30
version_info.html.template doc/rust.HTML: proper version box 2013-10-19 20:31:53 +02: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=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