Please check the build logs and, if you believe this is docs.rs' fault, open an issue.
Compiled on the nightly channel of Rust. Use rustup for managing compiler channels. Download the exact same version of the compiler used with
rustup override add nightly-2016-05-16.
Please consult the Oak manual.
- Grammar description as a Rust syntax extension.
- Generation of both recognizer and parser functions for each rules.
- Type inference for each parsing expressions. Simplify the AST construction.
Build local documentation
You might want to build the manual or code documentation from the repository because you need it to be synchronized with a specific version of Oak or simply for offline usage. Here how to do it!
Build the manual
You need the utility
git clone https://github.com/steveklabnik/rustbook.git cd rustbook cargo build
Once built, go inside
oak/doc and execute
rustbook build. The manual is generated inside a local folder named
Build the code documentation
You should be interested by the runtime documentation which is the one useful for users.
cd oak/runtime cargo doc
The documentation is available in
If you want the developer documentation of the Oak compiler, go to the root of the project and launch:
cd oak rustdoc --no-defaults --passes "collapse-docs" --passes "unindent-comments" --output=target/dev-doc src/liboak/lib.rs
The documentation will be available inside