rust/doc
OGINO Masanori 20ec0be779 Remove *.pot files and ignore them now.
The .pot files can be generated automatically and the files contain
timestamps in their content. They can cause huge conflicts and take huge
space even if you are not a translator.

This commit is a part of improvement discussed on
https://github.com/mozilla/rust/pull/11383 .

Signed-off-by: OGINO Masanori <masanori.ogino@gmail.com>
2014-01-10 07:21:32 +09:00
..
lib Remove fail keyword from lexer & parser and clean up remaining calls to 2013-02-01 00:15:42 -08:00
po/ja Remove *.pot files and ignore them now. 2014-01-10 07:21:32 +09:00
complement-bugreport.md First phase of migrating the wiki to the internal docs #11078 2014-01-06 15:27:49 -06:00
complement-cheatsheet.md Fix cheatsheet examples on 32-bit platforms. 2014-01-09 02:16:36 +11:00
complement-lang-faq.md 'borrowed pointer' -> 'reference' 2014-01-07 18:49:13 -08:00
complement-project-faq.md First phase of migrating the wiki to the internal docs #11078 2014-01-06 15:27:49 -06:00
complement-usage-faq.md First phase of migrating the wiki to the internal docs #11078 2014-01-06 15:27:49 -06:00
favicon.inc doc: add favicon to tutorial/manual 2013-11-13 09:32:50 +01:00
full-toc.inc First phase of migrating the wiki to the internal docs #11078 2014-01-06 15:27:49 -06:00
guide-conditions.md doc: Title guides consistently 2014-01-07 17:01:06 -08:00
guide-container.md doc: Title guides consistently 2014-01-07 17:01:06 -08:00
guide-ffi.md 'borrowed pointer' -> 'reference' 2014-01-07 18:49:13 -08:00
guide-lifetimes.md 'borrowed pointer' -> 'reference' 2014-01-07 18:49:13 -08:00
guide-macros.md doc: Title guides consistently 2014-01-07 17:01:06 -08:00
guide-pointers.md Fixed code snippets 2014-01-07 21:30:17 -08:00
guide-rustpkg.md doc: Title guides consistently 2014-01-07 17:01:06 -08:00
guide-tasks.md doc: Title guides consistently 2014-01-07 17:01:06 -08:00
guide-testing.md Remove ApproxEq and assert_approx_eq! 2014-01-09 15:41:46 +11:00
index.md doc: Add rustc and syntax to the index 2014-01-07 21:23:26 -08:00
po4a.conf Update doc/po4a.conf for recent changes. 2014-01-10 07:21:32 +09:00
prep.js fix escape 2012-10-05 12:41:00 -07:00
README doc: switch pandoc to html5 2013-10-19 20:29:34 +02:00
rust.css First phase of migrating the wiki to the internal docs #11078 2014-01-06 15:27:49 -06:00
rust.md 'borrowed pointer' -> 'reference' 2014-01-07 18:49:13 -08:00
rustdoc.md auto merge of #11185 : huonw/rust/doc-ignore, r=cmr 2013-12-30 05:51:51 -08:00
rustpkg.md Update Docs to use crateid 2013-12-29 15:25:43 -05:00
tutorial.md doc: Typos 2014-01-07 21:31:37 -08:00
version_info.html.template doc/rust.HTML: proper version box 2013-10-19 20:31:53 +02: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=html5 --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