rust/src/doc
bors 2ab18ce6f7 Auto merge of #34660 - jseyfried:fix_parse_stmt, r=nrc
Fix bugs in macro-expanded statement parsing

Fixes #34543.

This is a [breaking-change]. For example, the following would break:
```rust
macro_rules! m { () => {
    println!("") println!("")
    //^ Semicolons are now required on macro-expanded non-braced macro invocations
    //| in statement positions.
    let x = 0
    //^ Semicolons are now required on macro-expanded `let` statements
    //| that are followed by more statements, so this would break.
    let y = 0 //< (this would still be allowed to reduce breakage in the wild)
}
fn main() { m!() }
```

r? @eddyb
2016-07-13 01:37:07 -07:00
..
book Auto merge of #34660 - jseyfried:fix_parse_stmt, r=nrc 2016-07-13 01:37:07 -07:00
nomicon Auto merge of #33895 - AndrewBrinker:master, r=steveklabnik 2016-06-09 07:13:34 -07:00
style
complement-design-faq.md
complement-lang-faq.md
complement-project-faq.md
favicon.inc
footer.inc Rollup merge of #33385 - cheercroaker:doc-correction, r=brson 2016-06-01 12:57:40 +05:30
full-toc.inc
grammar.md
guide-crates.md
guide-error-handling.md
guide-ffi.md
guide-macros.md
guide-ownership.md
guide-plugins.md
guide-pointers.md
guide-strings.md
guide-tasks.md
guide-testing.md
guide-unsafe.md
guide.md
index.md
intro.md
not_found.md
README.md
reference.md Rollup merge of #34742 - abhijeetbhagat:master, r=steveklabnik 2016-07-12 12:08:23 +02:00
rust.css
rust.md
rustc-ux-guidelines.md diagnostics comes from different places now 2016-06-20 16:05:30 +08:00
rustdoc.md
tutorial.md
version_info.html.template

Rust documentations

Building

To generate all the docs, follow the "Building Documentation" instructions in the README in the root of the repository. This will convert the distributed Markdown docs to HTML and generate HTML doc for the books, '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:

rustdoc reference.md

(reference.md being the Rust Reference Manual.)

An overview of how to use the rustdoc command is available in the docs. Further details are available from the command line by with rustdoc --help.