feature request: build docs for dependencies only
Open
Nobody has claimed this yet.
C-enhancement
Command-doc
S-needs-info
- Dominant language
- Rust
- Stars
- 15.5k
- Forks
- 3k
- Avg merge
- 23h 30m
- Merged PRs (30d)
- 51
Description
Idea: add a new flag to cargo-doc doing the opposite of --no-deps (e.g. --deps-only).
It would be useful to be able to do
cargo doc --deps-only --open
to generate the documentation for the dependencies of the crate, even when the crate itself doesn't compile.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start at the cargo doc command and trace how its existing --no-deps flag controls dependency documentation. Define the inverse --deps-only behavior, then verify that cargo doc --deps-only --open documents dependencies when the crate itself does not compile.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- build-system, cli
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 52/100