rust/doc
2013-12-23 09:10:37 -08:00
..
lib Remove fail keyword from lexer & parser and clean up remaining calls to 2013-02-01 00:15:42 -08:00
po std::vec: convert to(_mut)_ptr to as_... methods on &[] and &mut []. 2013-12-15 23:37:41 +11:00
favicon.inc doc: add favicon to tutorial/manual 2013-11-13 09:32:50 +01:00
manual.inc doc: CSS changes + commit improved favicon 2013-12-13 21:50:26 +01: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: forward-port the conditions tutorial + fixup libstd example 2013-12-20 18:40:26 +01:00
rust.md auto merge of #10972 : metajack/rust/pkgid-with-name, r=alexcrichton 2013-12-17 07:41:40 -08:00
rustdoc.md Fixing more doc tests 2013-12-23 09:10:37 -08:00
rustpkg.md Update documentation for new pkgid attribute. 2013-12-12 15:22:23 -07:00
tutorial-borrowed-ptr.md remove the float type 2013-10-01 14:54:10 -04:00
tutorial-conditions.md doc: forward-port the conditions tutorial + fixup libstd example 2013-12-20 18:40:26 +01:00
tutorial-container.md Forbid privacy in inner functions 2013-11-17 21:28:18 -08:00
tutorial-ffi.md std::vec: convert to(_mut)_ptr to as_... methods on &[] and &mut []. 2013-12-15 23:37:41 +11:00
tutorial-macros.md Forbid privacy in inner functions 2013-11-17 21:28:18 -08:00
tutorial-rustpkg.md Add missing .com 2013-12-09 17:40:10 +01:00
tutorial-tasks.md Test fallout from std::comm rewrite 2013-12-16 22:55:49 -08:00
tutorial.md auto merge of #10944 : metajack/rust/pkgid-docs, r=cmr 2013-12-14 08:11:29 -08:00
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