Expand description
docs-md library interface for testing and reuse.
This module exposes the core functionality of docs-md as a library, allowing integration tests and external tools to use the markdown generation capabilities programmatically.
Re-exports§
pub use crate::generator::Generator;pub use crate::generator::MarkdownCapture;pub use crate::generator::RenderConfig;pub use crate::generator::SourceConfig;pub use crate::linker::AnchorUtils;pub use crate::linker::LinkRegistry;pub use crate::multi_crate::CrateCollection;pub use crate::multi_crate::MultiCrateContext;pub use crate::multi_crate::MultiCrateGenerator;pub use crate::multi_crate::MultiCrateParser;pub use crate::multi_crate::SearchIndex;pub use crate::multi_crate::SearchIndexGenerator;pub use crate::multi_crate::UnifiedLinkRegistry;
Modules§
- error
- Error types for docs-md.
- generator
- Markdown documentation generator for rustdoc JSON.
- linker
- Cross-reference linking for markdown documentation.
- multi_
crate - Multi-crate documentation generation.
- parser
- Rustdoc JSON parsing module.
- source
- Source code parsing for enhanced documentation.
- types
- Type rendering utilities for converting rustdoc types to string representations.
- utils
- Shared utility functions used across the documentation generator.
Structs§
- Cli
- Top-level CLI for docs-md.
- Collect
Sources Args - Arguments for the
collect-sourcessubcommand. - Docs
Args - Arguments for the
docssubcommand (build + generate). - Generate
Args - Command-line arguments for direct generation (no subcommand).
Enums§
- Cargo
- Cargo wrapper for subcommand invocation.
- CliOutput
Format - CLI-compatible output format enum (for clap
ValueEnumderive). - Command
- Available subcommands
- Output
Format - Output format for the generated markdown documentation.
Type Aliases§
- Args
- Backwards-compatible type alias for existing code.