rust/doc
Ramkumar Ramachandra dd923e3831 tutorial: fix for-loop example
Although in the example function `each` works as expected with
rust-0.6 (the latest release), it fails to even compile with `incoming`
rust (see test/compile-fail/bad-for-loop-2.rs). Change the function to
return a `bool` instead of `()`: this works fine with both versions of
rust, and does not misguide potential contributors.

Signed-off-by: Ramkumar Ramachandra <artagnon@gmail.com>
2013-06-06 19:43:16 +05:30
..
lib
lib.css
manual.css
prep.js
README add gitattributes and fix whitespace issues 2013-05-03 20:01:42 -04:00
rust.css
rust.md Fix duplicate words in the docs 2013-06-06 10:43:58 +03:00
rustpkg.md docs: Mention recently-added rustpkg features in the rustpkg manual 2013-06-02 17:21:01 -07:00
tutorial-borrowed-ptr.md Replace shared/unique by managed/owned in the tutorial 2013-05-14 22:25:55 +09:00
tutorial-ffi.md librustc: Disallow multiple patterns from appearing in a "let" declaration. 2013-06-04 21:45:42 -07:00
tutorial-macros.md librustc: Disallow multiple patterns from appearing in a "let" declaration. 2013-06-04 21:45:42 -07:00
tutorial-tasks.md librustc: Stop reexporting the standard modules from prelude. 2013-05-29 19:04:53 -07:00
tutorial.md tutorial: fix for-loop example 2013-06-06 19:43:16 +05:30
version_info.html.template add gitattributes and fix whitespace issues 2013-05-03 20:01:42 -04:00

The markdown docs are only generated by make when node is installed (use
`make doc`). If you don't have node installed you can generate them yourself.
Unfortunately there's no real standard for markdown and all the tools work
differently. pandoc is one that seems to work well.

To generate an html version of a doc do something like:
pandoc --from=markdown --to=html --number-sections -o build/doc/rust.html doc/rust.md && git web--browse build/doc/rust.html

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