Crate ripdoc

Crate ripdoc 

Source
Expand description

Core library for ripdoc, providing the main API for rendering Rust documentation.

This crate provides the high-level Ripdoc API which orchestrates target resolution, crate documentation generation, and rendering. It is designed to be UI-agnostic and can be used by any frontend (CLI, GUI, language server, etc.).

Re-exports§

pub use crate::cargo_utils::target;
pub use crate::core_api::ListTreeNode;
pub use crate::core_api::RenderFormat;
pub use crate::core_api::Result;
pub use crate::core_api::Ripdoc;
pub use crate::core_api::SearchDomain;
pub use crate::core_api::SearchItemKind;
pub use crate::core_api::SearchOptions;
pub use crate::core_api::SearchResponse;
pub use crate::core_api::SourceLocation;
pub use crate::core_api::build_list_tree;

Modules§

cargo_utils
Utilities for querying Cargo metadata and managing crate sources. Utilities for querying Cargo metadata and managing crate sources.
core_api
Core API for ripdoc operations. Core library for ripdoc, providing the main API for rendering Rust documentation.
render
Rendering logic that converts rustdoc data into skeleton Rust code. Rendering logic that converts rustdoc data into skeleton Rust code.
skelebuild
Pseudo-interactive skeleton builder.

Macros§

extract_item
Convenience macro to destructure rustdoc_types::Item variants during rendering.