rust/doc
bors 9f671698e6 auto merge of #6106 : thestinger/rust/iter, r=bstrie
I don't have a strong opinion on the function vs. method, but there's no point in having both. I'd like to make a `repeat` adaptor like Python/Haskell for turning a value into an infinite stream of the value, so this has to at least be renamed.
2013-05-19 08:13:30 -07:00
..
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 syntax: implement #[deriving(DeepClone)]. Fixes #6514. 2013-05-16 22:55:08 +10:00
rustpkg.md rustpkg: In doc, mention other implicit RUST_PATH entries 2013-04-22 18:17:32 -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 libsyntax: Remove extern mod foo { ... } from the language. 2013-05-12 16:33:15 -07:00
tutorial-macros.md Use static string with fail!() and remove fail!(fmt!()) 2013-05-14 16:36:23 +02:00
tutorial-tasks.md Add a small section on futures to the tutorial 2013-05-17 23:11:49 +02:00
tutorial.md replace old_iter::repeat with the Times trait 2013-05-18 04:57:21 -04:00
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