Skip to content

Combine rustdoc output of multiple, discrete crates.

License

Notifications You must be signed in to change notification settings

lukesneeringer/doc-merge

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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/

About

Combine rustdoc output of multiple, discrete crates.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published