rust/doc at 790e6bb3972c3b167a8e0314305740a20f62d2f0 - rust

History

bors 790e6bb397 auto merge of #8490 : huonw/rust/fromiterator-extendable, r=catamorphism If they are on the trait then it is extremely annoying to use them as generic parameters to a function, e.g. with the iterator param on the trait itself, if one was to pass an Extendable<int> to a function that filled it either from a Range or a Map<VecIterator>, one needs to write something like: fn foo<E: Extendable<int, Range<int>> + Extendable<int, Map<&'self int, int, VecIterator<int>>> (e: &mut E, ...) { ... } since using a generic, i.e. `foo<E: Extendable<int, I>, I: Iterator<int>>` means that `foo` takes 2 type parameters, and the caller has to specify them (which doesn't work anyway, as they'll mismatch with the iterators used in `foo` itself). This patch changes it to: fn foo<E: Extendable<int>>(e: &mut E, ...) { ... }		2013-08-15 02:56:08 -07:00
..
lib	Remove fail keyword from lexer & parser and clean up remaining calls to	2013-02-01 00:15:42 -08:00
po	auto merge of #8490 : huonw/rust/fromiterator-extendable, r=catamorphism	2013-08-15 02:56:08 -07:00
lib.css	Establish 'core' library separate from 'std'.	2011-12-06 12:13:04 -08:00
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	fix escape	2012-10-05 12:41:00 -07:00
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	std/rustc/rustpkg/syntax: Support the `extern mod = ...` form	2013-08-09 14:11:50 -07:00
rustpkg.md	docs: In rustpkg manual, note future plans about versions	2013-08-09 18:26:22 -07:00
tutorial-borrowed-ptr.md	fix text of tutorials	2013-06-21 00:53:10 -04:00
tutorial-container.md	std: Move the iterator param on FromIterator and Extendable to the method.	2013-08-15 01:10:45 +10:00
tutorial-ffi.md	Add some documentation about globals in ffi docs	2013-08-07 22:41:14 -04: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	Disable linked failure tests	2013-08-07 16:32:20 -07:00
tutorial.md	Remove unnecessary return	2013-08-12 20:52:37 -04:00
version_info.html.template	add gitattributes and fix whitespace issues	2013-05-03 20:01:42 -04:00

README

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