Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
..
Failed to load latest commit information.
style doc: Fix extraneous as_slice()'s in docstrings
trpl Rollup merge of #23804 - dnwade:patch-1, r=Manishearth
README.md remove l10n
complement-design-faq.md Add note about pre/post increment to the design FAQ.
complement-lang-faq.md doc: fix links to servo
complement-project-faq.md doc: fix links to servo
favicon.inc webfonts: serve Source Code Pro locally
footer.inc Bump copyright year in doc footer
full-toc.inc doc: add webfonts and tweak the styles accordingly
grammar.md Strip trailing whitespace
guide-crates.md Grammar tweak to old guide stub documents.
guide-error-handling.md Grammar tweak to old guide stub documents.
guide-ffi.md Grammar tweak to old guide stub documents.
guide-macros.md Grammar tweak to old guide stub documents.
guide-ownership.md Grammar tweak to old guide stub documents.
guide-plugins.md Grammar tweak to old guide stub documents.
guide-pointers.md Grammar tweak to old guide stub documents.
guide-strings.md Grammar tweak to old guide stub documents.
guide-tasks.md Fix broken link in old rust guide
guide-testing.md Grammar tweak to old guide stub documents.
guide-unsafe.md Grammar tweak to old guide stub documents.
guide.md Grammar tweak to old guide stub documents.
index.md Fix "How to submit a bug report" link
intro.md Re-word explanation on closures in intro
not_found.md Strip all leading/trailing newlines
reference.md rollup merge of #23786: alexcrichton/less-quotes
rust.css Enforce a white background for the docs
rust.md Update based on PR feedback
rustdoc.md Move rustdoc.md into the book
tutorial.md Re-direct to the right place.
uptack.tex Changed LaTex $\bot$s to ⊥
version_info.html.template Update repo location

README.md

Rust documentations

Dependencies

Pandoc, a universal document converter, is required to generate docs as HTML from Rust's source code.

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 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 manually, you can do something like:

pandoc --from=markdown --to=html5 --number-sections -o reference.html reference.md

(reference.md being the Rust Reference Manual.)

The syntax for pandoc flavored markdown can be found at:

A nice quick reference (for non-pandoc markdown) is at:

Something went wrong with that request. Please try again.