GitHunt
LU

lukesneeringer/doc-merge

Combine rustdoc output of multiple, discrete crates.

doc-merge

This crate provides a primitive doc-merge command.

It does one and exactly one thing: it lets you combine the cargo doc output from multiple crates
into one location and adds an index. If you have multiple crates that you want to combine into a
single documentation site, this crate might be what you need.

While it's not a requirement, this crate is written with the expectation that you are usually
running cargo doc --no-deps, because you're trying to document your own crates, and not their
dependencies.

Installation

$ cargo install doc-merge

Usage

From a crate root:

$ doc-merge --dest /path/to/docs/

From somewhere else:

$ doc-merge --src /path/to/crate/target/doc/ --dest /path/to/docs/

Languages

Rust55.0%HTML45.0%

Contributors

MIT License
Created May 22, 2023
Updated December 3, 2024