sourcey

Native documentation tooling for Rust APIs. Companion crate to the sourcey static documentation generator.

This crate is the Rust-side entrypoint to sourcey's rustdoc() source adapter pipeline. It re-exports sourcey-rustdoc, the helper that converts nightly rustdoc JSON into a stable RustdocSpec snapshot.

use sourcey::{RustdocSpec, SPEC_VERSION};

let bytes = std::fs::read("snapshots/rustdoc.json")?;
let spec: RustdocSpec = serde_json::from_slice(&bytes)?;
assert_eq!(spec.version, SPEC_VERSION, "schema version mismatch");

for krate in &spec.crates {
    println!("{} has {} items", krate.name, krate.items.len());
}

What is sourcey?

sourcey is a static documentation generator that ships on npm as sourcey. It turns OpenAPI specs, MCP servers, Doxygen XML, godoc output, rustdoc JSON, and rich markdown into a single owned static site.

The Rust side is opt-in: most users install sourcey via npm and run npx sourcey init. This crate exists so Rust projects that want to drive snapshot generation from Rust (CI tools, custom build scripts, alternative renderers) can use the same pipeline as a library.

Documentation

• Homepage: sourcey.com
• Docs: sourcey.com/docs
• rustdoc adapter guide: sourcey.com/docs/adapters/rustdoc
• API docs: docs.rs/sourcey
• Repository: github.com/sourcey/sourcey

License

AGPL-3.0-only. Same license as the main sourcey npm package.