Examples / rustdoc

runx Rust API

A live Rust API reference generated from runx's nightly rustdoc JSON with native Sourcey rustdoc support.

runx Rust API preview

Features demonstrated

  • Rust API reference produced from nightly rustdoc JSON
  • Modules, structs, enums, traits, impls, macros, type aliases, constants, statics, re-exports
  • First-class doctests with hidden-line toggle, fence-attribute badges, and Rust Playground deep-links
  • Dedicated doctests index that aggregates every runnable example across the workspace
  • Snapshot mode lets CI build without nightly installed
  • Search and llms-full.txt include rust function, method, trait, and doctest categories

runx is the live Rust proof for Sourcey’s rustdoc support. The reference is generated from runx’s nightly rustdoc JSON snapshot, then published alongside guides, REST API reference, and MCP reference inside the same docs site.

The point is the same as the C++ and Go showcases: the parser is the useful part. Sourcey replaces the output layer.

Source

The source is runx’s Rust workspace. A bundled helper converts nightly rustdoc JSON into a stable RustdocSpec v1 snapshot. The runx docs site commits that snapshot so CI builds the rust-api tab on stable Rust toolchains.

Output

The generated Rust API tab gives runx stable module, item, and doctest anchors inside the same docs experience as the rest of the project. Every doctest is runnable through a Playground deep-link. Doc aliases and item names are indexed in search. The whole reference contributes to llms-full.txt so agents can read the real API surface without checking out the repository.

Why it matters

For Rust projects, docs.rs is a strong global index. It is not a replacement for product-owned docs. runx shows the shape Sourcey is aiming for: native Rust reference, generated from rustdoc JSON, published as static docs the project owns, with doctests as a first-class extracted view.

rustdocrustapi-referencerunxdoctests