mirror of
https://github.com/rust-lang/rust.git
synced 2025-02-03 18:43:38 +00:00
96fd606ddd
This commit allows you to write: extern mod x = "a/b/c"; which means rustc will search in the RUST_PATH for a package with ID a/b/c, and bind it to the name `x` if it's found. Incidentally, move get_relative_to from back::rpath into std::path |
||
|---|---|---|
| .. | ||
| lib | ||
| po | ||
| lib.css | ||
| manual.css | ||
| po4a.conf | ||
| prep.js | ||
| README | ||
| rust.css | ||
| rust.md | ||
| rustpkg.md | ||
| tutorial-borrowed-ptr.md | ||
| tutorial-container.md | ||
| tutorial-ffi.md | ||
| tutorial-macros.md | ||
| tutorial-tasks.md | ||
| tutorial.md | ||
| 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