3 releases (breaking)

0.3.0 Oct 18, 2023
0.2.0 Oct 18, 2023
0.1.0 May 22, 2023

#973 in Development tools

28 downloads per month

MIT license

9KB
130 lines

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/

Dependencies

~3.5–5MB
~91K SLoC