rust/src/doc
Steve Klabnik fcb1ccf8c0 Rollup merge of #30727 - tbu-:pr_doc_escaped_newline, r=steveklabnik
Rust differs in that behavior from C: In C, the newline escapes are resolved
before anything else, and in Rust this depends on whether the backslash is
escaped itself.

A difference can be observed in the following two programs:

```c
int main()
{
	printf("\\
n\n");
	return 0;
}
```

```rust
fn main() {
	println!("\\
n");
}
```

The first program prints two newlines, the second one prints a backslash, a
newline, the latin character n and a final newline.
2016-01-06 18:31:58 -05:00
..
book Rollup merge of #30720 - BChip:patch-1, r=steveklabnik 2016-01-06 18:31:57 -05:00
nomicon Change "big ask" to "tall order" in Rustonomicon. 2015-12-17 09:40:02 -08:00
style Fix double word 'be' 2015-11-08 09:39:01 -06:00
complement-design-faq.md Remove the FAQs in favor of the website 2015-12-23 14:03:45 -08:00
complement-lang-faq.md Remove the FAQs in favor of the website 2015-12-23 14:03:45 -08:00
complement-project-faq.md Remove the FAQs in favor of the website 2015-12-23 14:03:45 -08:00
favicon.inc Use https URLs to refer to rust-lang.org where appropriate. 2015-08-09 14:28:46 -07:00
footer.inc Convert playpen.js to plain JS. 2015-06-12 16:26:07 -04:00
full-toc.inc doc: add webfonts and tweak the styles accordingly 2014-04-19 21:25:35 +09:00
grammar.md Allow bare semicolon in grammar doc, closes #28157 2015-10-24 00:45:18 +02:00
guide-crates.md Grammar tweak to old guide stub documents. 2015-01-16 22:25:22 -05:00
guide-error-handling.md Grammar tweak to old guide stub documents. 2015-01-16 22:25:22 -05:00
guide-ffi.md Grammar tweak to old guide stub documents. 2015-01-16 22:25:22 -05:00
guide-macros.md Grammar tweak to old guide stub documents. 2015-01-16 22:25:22 -05:00
guide-ownership.md Grammar tweak to old guide stub documents. 2015-01-16 22:25:22 -05:00
guide-plugins.md Grammar tweak to old guide stub documents. 2015-01-16 22:25:22 -05:00
guide-pointers.md Change removal notice for pointer guide. 2015-06-29 15:18:00 -04:00
guide-strings.md Grammar tweak to old guide stub documents. 2015-01-16 22:25:22 -05:00
guide-tasks.md Fix broken link in old rust guide 2015-03-04 23:18:24 +00:00
guide-testing.md Grammar tweak to old guide stub documents. 2015-01-16 22:25:22 -05:00
guide-unsafe.md Grammar tweak to old guide stub documents. 2015-01-16 22:25:22 -05:00
guide.md Grammar tweak to old guide stub documents. 2015-01-16 22:25:22 -05:00
index.md Strip the documentation index down to the essentials. 2015-12-23 14:15:13 -08:00
intro.md Remove the 30 minute intro 2015-04-18 17:55:31 -04:00
not_found.md Use https URLs to refer to rust-lang.org where appropriate. 2015-08-09 14:28:46 -07:00
README.md Fix path to TRPL in doc README 2015-11-30 15:00:30 -05:00
reference.md Clarify how Rust treats backslashes at end of line in string literals 2016-01-06 00:04:25 +01:00
rust.css Update the playpen link for code in the rust book to agree with rustdoc's new style 2015-10-25 16:18:55 -04:00
rust.md Update based on PR feedback 2014-09-30 18:54:03 +02:00
rustc-ux-guidelines.md Add rustc UX guidelines. 2015-11-08 13:23:18 +00:00
rustdoc.md Move rustdoc.md into the book 2015-01-21 14:59:25 -05:00
tutorial.md Re-direct to the right place. 2015-01-13 21:11:47 -05:00
uptack.tex Changed LaTex $\bot$s to ⊥ 2014-12-19 18:09:33 -05:00
version_info.html.template Use https URLs to refer to rust-lang.org where appropriate. 2015-08-09 14:28:46 -07:00

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.