mirror of
https://github.com/rust-lang/rust.git
synced 2024-12-01 13:18:54 +01:00
88bec09e63
1. The section on trait definitions of static methods should include
a trait with a static method in the generated document.
2. The section on trait inheritance had a expression that appears
nonsensical ("let mycircle = @mycircle") in the generated document.
The text would be clearer (IMO) if we continued with the running
example of CircleStruct.
|
||
|---|---|---|
| .. | ||
| lib | ||
| lib.css | ||
| manual.css | ||
| prep.js | ||
| README | ||
| rust.css | ||
| rust.md | ||
| tutorial-borrowed-ptr.md | ||
| tutorial-ffi.md | ||
| tutorial-macros.md | ||
| tutorial-tasks.md | ||
| tutorial.md | ||
| 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