doc-merge

Crates.iodoc-merge
lib.rsdoc-merge
version0.3.0
sourcesrc
created_at2023-05-22 16:42:48.157161
updated_at2023-10-18 23:03:29.775187
descriptionCombine rustdoc output of multiple, discrete crates
homepage
repositoryhttps://github.com/lukesneeringer/doc-merge
max_upload_size
id870847
size23,171
Luke Sneeringer (lukesneeringer)

documentation

README

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/
Commit count: 5

cargo fmt