CODEWITHSUNDEEP
rustrust-cargo
lthms
lthms

Reputation: 519

How can I include private modules when generating documentation via Cargo?

I'm currently working on a project with Rust and Cargo. It works well, but I encounter a little issue: for code reuse, most of my project is inside a lib crate. In this crate, a lot of things is private. So when I do cargo doc, I just have documentation for public, exported stuff... which is actually great, because it's easy to see what is exported and what is not.

But I have to admit: I miss a complete documentation of the whole project, for development purpose...

Upvotes: 23

Views: 6713

Answers (4)

Shepmaster
Shepmaster

Reputation: 430791

Rust 1.41

Documentation for binaries includes private items from the binary crate by default.

Rust 1.29

You can now use cargo doc --document-private-items

Previous versions

You may not be able to do it with Cargo today, there is a workaround if you use rustdoc directly.

Run cargo doc -v and make a note of the rustdoc command it runs:

$ cargo doc -v
   Compiling docz v0.0.1 (file:///private/tmp/docz)
     Running `rustdoc src/lib.rs -o /private/tmp/docz/target/doc --crate-name docz -L dependency=/private/tmp/docz/target/debug -L dependency=/private/tmp/docz/target/debug/deps`

Then, add --no-defaults --passes strip-hidden --passes collapse-docs --passes unindent-comments to the command:

rustdoc src/lib.rs -o /private/tmp/docz/target/doc --crate-name docz \
    -L dependency=/private/tmp/docz/target/debug \
    -L dependency=/private/tmp/docz/target/debug/deps \
    --no-defaults \
    --passes strip-hidden --passes collapse-docs --passes unindent-comments

Upvotes: 25

joelparkerhenderson
joelparkerhenderson

Reputation: 35453

Use cargo to document private items:

cargo doc --document-private-items

Upvotes: 14

Zitrax
Zitrax

Reputation: 20255

This is now simpler, just use:

cargo rustdoc -- --document-private-items

Upvotes: 8

ideasman42
ideasman42

Reputation: 48058

This can be done by passing arguments to rustdoc, after --, eg.

cargo rustdoc -- \
    --no-defaults \
    --passes strip-hidden \
    --passes collapse-docs \
    --passes unindent-comments \
    --passes strip-priv-imports

Based on @Shepmaster's answer, no need for manual copy-pasting.

Upvotes: 8

Related Questions