rust/doc
bors 2aa578efd9 auto merge of #9115 : erickt/rust/master, r=erickt
This is a series of patches to modernize option and result. The highlights are:

* rename `.unwrap_or_default(value)` and etc to `.unwrap_or(value)`
* add `.unwrap_or_default()` that uses the `Default` trait
* add `Default` implementations for vecs, HashMap, Option
* add  `Option.and(T) -> Option<T>`, `Option.and_then(&fn() -> Option<T>) -> Option<T>`, `Option.or(T) -> Option<T>`, and `Option.or_else(&fn() -> Option<T>) -> Option<T>`
* add `option::ToOption`, `option::IntoOption`, `option::AsOption`, `result::ToResult`, `result::IntoResult`, `result::AsResult`, `either::ToEither`, and `either::IntoEither`, `either::AsEither`
* renamed `Option::chain*` and `Result::chain*` to `and_then` and `or_else` to avoid the eventual collision with `Iterator.chain`.
* Added a bunch of impls of `Default`
* Added a `#[deriving(Default)]` syntax extension
* Removed impls of `Zero` for `Option<T>` and vecs.
2013-09-14 00:01:04 -07:00
..
lib
po auto merge of #8490 : huonw/rust/fromiterator-extendable, r=catamorphism 2013-08-15 02:56:08 -07:00
lib.css
manual.css
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
rust.md Document the Zero trait 2013-09-12 18:54:13 -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 fix text of tutorials 2013-06-21 00:53:10 -04:00
tutorial-conditions.md doc: add condition tutorial 2013-08-19 16:48:48 -07:00
tutorial-container.md rename std::iterator to std::iter 2013-09-09 03:21:46 -04:00
tutorial-ffi.md Update FFI tutorial to reference c_str::to_c_str 2013-08-22 17:03:06 -07:00
tutorial-macros.md
tutorial-tasks.md doc: Remove statement about scheduling randomness 2013-08-28 11:23:32 -07:00
tutorial.md Document the Zero trait 2013-09-12 18:54:13 -07:00
version_info.html.template

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