Skip to content

Latest commit

 

History

History
37 lines (24 loc) · 1.08 KB

README.md

File metadata and controls

37 lines (24 loc) · 1.08 KB

rustdoc-static

A frontend that can be used with the new rustdoc to generate static documentation.

Usage

rustdoc-static is intended to be used with the new rustdoc as a pluggable frontend.

To use this frontend instead of the built-in frontend, build the frontend and set the RUSTDOC_FRONTEND environment variable.

$ cargo build --release
$ export RUSTDOC_FRONTEND=/path/to/repo/target/release/rustdoc-static

Now, run rustdoc on your target crate. Documentation will be generated in the crate's target/doc directory.

License

Licensed under either of

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.