77eeddaa48
The official documentation sorely needs an explanation of the rust runtime and what it is exactly, and I want this guide to provide that information. I'm unsure of whether I've been too light on some topics while too heavy on others. I also feel like a few things are still missing. As always, feedback is appreciated, especially about things you'd like to see written about! |
||
|---|---|---|
| .. | ||
| lib | ||
| po/ja | ||
| complement-bugreport.md | ||
| complement-cheatsheet.md | ||
| complement-lang-faq.md | ||
| complement-project-faq.md | ||
| complement-usage-faq.md | ||
| favicon.inc | ||
| full-toc.inc | ||
| guide-conditions.md | ||
| guide-container.md | ||
| guide-ffi.md | ||
| guide-lifetimes.md | ||
| guide-macros.md | ||
| guide-pointers.md | ||
| guide-runtime.md | ||
| guide-rustpkg.md | ||
| guide-tasks.md | ||
| guide-testing.md | ||
| index.md | ||
| po4a.conf | ||
| prep.js | ||
| README.md | ||
| rust.css | ||
| rust.md | ||
| rustdoc.md | ||
| rustpkg.md | ||
| tutorial.md | ||
| version_info.html.template | ||
Dependencies
Pandoc, a universal document converter, is required to generate docs as HTML from Rust's source code.
Node.js is also required for generating HTML from the Markdown docs (reference manual, tutorials, etc.) distributed with this git repository.
Building
To generate all the docs, just 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 a working build of the rustdoc tool.)
Additional notes
To generate an HTML version of a doc from Markdown without having Node.js installed, you can do something like:
pandoc --from=markdown --to=html5 --number-sections -o rust.html rust.md
(rust.md being the Rust Reference Manual.)
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