mirror of https://github.com/rust-lang/rust.git synced 2026-05-22 18:15:07 +03:00

Files

T

Guillaume Gomez ef45ec0a24 Rollup merge of #38225 - Cobrand:patch-1, r=GuillaumeGomez

Update book/ffi to use catch_unwind

r? @GuillaumeGomez

The doc mentioned to spawn a new thread instead of using catch_unwind, which has been the recommended way to catch panics for foreign function interfaces for a few releases now.

This commit fixes that.

2016-12-07 10:42:52 -08:00

book

Update book/ffi to use catch_unwind

2016-12-07 18:43:07 +01:00

nomicon

Fixed typo in nomicon

2016-09-07 22:15:32 +02: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

rustdoc: Improve playground run buttons

2016-10-15 18:32:03 +01:00

full-toc.inc

doc: add webfonts and tweak the styles accordingly

2014-04-19 21:25:35 +09:00

grammar.md

Add docs for "!" empty Never type (rfc 1216)

2016-08-20 22:13:40 +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

doc: Fix a bunch of broken links

2016-03-08 13:44:14 -08: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

Clarify the reference's status.

2016-11-17 13:16:27 -05: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

rustbuild: Run all markdown documentation tests

2016-04-19 09:52:56 -07:00

reference.md

Rollup merge of #38163 - durka:patch-33, r=bluss

2016-12-07 10:42:52 -08:00

rust.css

rustdoc: Improve playground run buttons

2016-10-15 18:32:03 +01:00

rust.md

Update based on PR feedback

2014-09-30 18:54:03 +02:00

rustc-ux-guidelines.md

diagnostics comes from different places now

2016-06-20 16:05:30 +08: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

version_info.html.template

Add alt tags for logos

2016-01-20 11:53:20 -05:00

README.md

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.