b613ef552d
This adds strictly more information to the source files and reduces the need for customized tooling to render the book. (While this should not change the output of _rustbook_, it is very useful when rendering the sources with external tools like Pandoc.) This only adds the language marker to "first level" code blocks (and not to code blocks in comments inside of code examples). r? @steveklabnik
Rust documentations
Dependencies
Pandoc, a universal document converter, is required to generate docs as HTML from Rust's source code.
Building
To generate all the docs, just run make docs from the root of the repository.
This will convert the distributed Markdown docs to HTML and generate HTML doc
for the '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:
pandoc --from=markdown --to=html5 --number-sections -o reference.html reference.md
(reference.md being the Rust Reference Manual.)
The syntax for pandoc flavored markdown can be found at:
A nice quick reference (for non-pandoc markdown) is at: