0
0
mirror of https://github.com/rust-lang/rust.git synced 2024-11-29 18:06:44 +01:00
rust/doc
bors 5da9e12778 auto merge of #5570 : alexcrichton/rust/fix-unused-imports, r=sanxiyn
Before it wouldn't warn about unused imports in the list if something in the list was used. These commits fix that case, add a test, and remove all unused imports in lists of imports throughout the compiler.
2013-03-29 05:57:44 -07:00
..
lib Remove fail keyword from lexer & parser and clean up remaining calls to 2013-02-01 00:15:42 -08:00
lib.css
manual.css
prep.js
README
rust.css rustdoc: Tweak list style 2013-03-26 09:31:44 -07:00
rust.md test: Fix tests 2013-03-26 22:45:22 -07:00
tutorial-borrowed-ptr.md librustc: Modify all code to use new lifetime binder syntax 2013-03-26 21:30:17 -07:00
tutorial-ffi.md librustc: Convert all uses of assert over to fail_unless! 2013-03-07 22:37:57 -08:00
tutorial-macros.md Copyedit macro tutorial 2013-03-22 16:11:27 -07:00
tutorial-tasks.md Removing unused imports 2013-03-28 23:56:46 -04:00
tutorial.md tutorial: only Owned types can have a Drop impl 2013-03-28 18:41:55 -04:00
version_info.html.template

The markdown docs are only generated by make when node is installed (use
`make doc`). If you don't have node installed you can generate them yourself. 
Unfortunately there's no real standard for markdown and all the tools work 
differently. pandoc is one that seems to work well.

To generate an html version of a doc do something like:
pandoc --from=markdown --to=html --number-sections -o build/doc/rust.html doc/rust.md && git web--browse build/doc/rust.html

The syntax for pandoc flavored markdown can be found at:
http://johnmacfarlane.net/pandoc/README.html#pandocs-markdown

A nice quick reference (for non-pandoc markdown) is at:
http://kramdown.rubyforge.org/quickref.html