Crate cargo_docs_md 

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.

CollectSourcesArgs

Arguments for the collect-sources subcommand.

DocsArgs

Arguments for the docs subcommand (build + generate).

GenerateArgs

Command-line arguments for direct generation (no subcommand).

Enums

Cargo

Cargo wrapper for subcommand invocation.

CliOutputFormat

CLI-compatible output format enum (for clap ValueEnum derive).

Command

Available subcommands

OutputFormat

Output format for the generated markdown documentation.

Functions

index_loop

Test function: index loop with assert (bounds check elided).

index_loop_no_assert

Test function: index loop without assert (bounds check present).

iter_zip

Test function: iterator zip (no bounds checks in loop).

Type Aliases

Args

Backwards-compatible type alias for existing code.