rust/src/doc
Corey Farwell e6f6b445aa Rollup merge of #40702 - mrhota:global_asm, r=nagisa
Implement global_asm!() (RFC 1548)

This is a first attempt. ~~One (potential) problem I haven't solved is how to handle multiple usages of `global_asm!` in a module/crate. It looks like `LLVMSetModuleInlineAsm` overwrites module asm, and `LLVMAppendModuleInlineAsm` is not provided in LLVM C headers 😦~~

I can provide more detail as needed, but honestly, there's not a lot going on here.

r? @eddyb

CC @Amanieu @jackpot51

Tracking issue: #35119
2017-04-14 17:41:03 -04:00
..
book@beea82b923 Update various bookshelf repositories. 2017-04-13 18:15:40 -04:00
nomicon@616b98444f Update various book modules 2017-03-27 17:41:58 -04:00
reference@b060f73214 Update various bookshelf repositories. 2017-04-13 18:15:40 -04:00
unstable-book Rollup merge of #40702 - mrhota:global_asm, r=nagisa 2017-04-14 17:41:03 -04: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 Get linkchecker clean 2017-02-21 14:02:12 -05: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 get linkcheck clean 2017-02-21 21:12:56 -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 Using X headings #39850 2017-03-13 19:13:26 -04: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 Redirect to the new reference 2017-02-21 14:03:13 -05:00
rust.css Avoid using locally installed Source Code Pro font (fixes #24355). 2016-12-04 13:44:19 -08:00
rust.md Avoid linking to a moved page in rust.html 2017-03-29 15:38:47 +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

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.