Expand description

Utilities for working with rustdoc JSON.

Building

Use rustdoc_json::Builder::build() to build rustdoc JSON. Like this:

let json_path = rustdoc_json::Builder::default()
    .toolchain("+nightly".to_owned())
    .manifest_path("Cargo.toml")
    .build()
    .unwrap();

println!("Built and wrote rustdoc JSON to {:?}", &json_path);

A compilable example can be found here

Re-exports

pub use Builder as BuildOptions;

Structs

Options for building a rustdoc json file.

Enums

Represents all errors that can occur when using Builder::build().

Functions

buildDeprecated
Generate rustdoc JSON for a library crate. Returns the path to the freshly built rustdoc JSON file.