Updated code sample in chapter on syntax extensions. The affected API apparently had changed with commit d59accfb065843d12db9180a4f504664e3d23ef1. --- Further more I had to add ```toml [lib] name = "roman_numerals" crate-type = ["dylib"] ``` to `Cargo.toml` as I otherwise got this compiler error (despite `#![crate_type="dylib"]`): [E0457]: plugin `roman_numerals` only found in rlib format, but must be available in dylib format Might be worth adding a note about that?
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
.