rust/doc
Erick Tryzelaar 0feaccf526 syntax: Add #[deriving(FromPrimitive)] syntax extension
Right now this only works for c-style enums.
2013-10-02 07:55:41 -07:00
..
lib Remove fail keyword from lexer & parser and clean up remaining calls to 2013-02-01 00:15:42 -08:00
po Update version numbers to 0.8 2013-09-21 16:25:08 -07:00
lib.css
manual.css Display the full TOC in the manual. Closes #4194 2012-12-14 18:06:21 -08:00
po4a.conf doc: Generate .po files for Japanse translations 2013-08-12 22:39:31 +09:00
prep.js
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 syntax: Add #[deriving(FromPrimitive)] syntax extension 2013-10-02 07:55:41 -07:00
rustpkg.md rustc/rustpkg: Use a target-specific subdirectory in build/ and lib/ 2013-09-13 10:43:22 -07:00
tutorial-borrowed-ptr.md remove the float type 2013-10-01 14:54:10 -04:00
tutorial-conditions.md tutorial: Remove usage of fmt! 2013-09-30 23:21:20 -07: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: Remove usage of fmt! 2013-09-30 23:21:20 -07:00
tutorial-rustpkg.md clarify that rust_pkg is a place-holder 2013-09-30 22:57:09 -05:00
tutorial-tasks.md remove the float type 2013-10-01 14:54:10 -04:00
tutorial.md remove the float type 2013-10-01 14:54:10 -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