Crate rustdoc_json

Utilities for working with rustdoc JSON.

Building

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

   use rustdoc_json::BuildOptions;

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

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

A compilable example can be found here

Structs

BuildOptions

Contains all options for crate::build().

Enums

BuildError

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

Functions

build

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