Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feature request: build docs for dependencies only #2801

Open
letheed opened this issue Jun 24, 2016 · 4 comments
Open

feature request: build docs for dependencies only #2801

letheed opened this issue Jun 24, 2016 · 4 comments
Labels
C-enhancement Category: enhancement Command-doc S-needs-info Status: Needs more info, such as a reproduction or more background for a feature request.

Comments

@letheed
Copy link

letheed commented Jun 24, 2016

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.

@KalitaAlexey
Copy link
Contributor

I like that idea because sometimes my code does not compile because of errors to fix those I need a documentation for some external crate.

@KalitaAlexey
Copy link
Contributor

I'll take it.

@kellda
Copy link
Contributor

kellda commented Jun 6, 2020

This is a duplicate of #2644 so maybe it can be closed ?

@epage epage added C-enhancement Category: enhancement S-triage Status: This issue is waiting on initial triage. labels Sep 28, 2023
@epage
Copy link
Contributor

epage commented Nov 22, 2024

This issue is specifically for documentation which has special dependency handling flags already like --no-deps. #2644 is broader build feature that is likely different enough in the needs there that we shouldn't combine the two.

For me, the question is how much is this

  • Wanting to have documentation targeted at me without taking the time to build local dependencies
  • Wanting have easy access to browsing what documentation did build when there is a failure (--keep-going can help for other workspace members)

if its the latter, I wonder if there is some level of still reporting or --opening we should do on error.

@epage epage added S-needs-info Status: Needs more info, such as a reproduction or more background for a feature request. and removed S-triage Status: This issue is waiting on initial triage. labels Nov 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C-enhancement Category: enhancement Command-doc S-needs-info Status: Needs more info, such as a reproduction or more background for a feature request.
Projects
None yet
Development

No branches or pull requests

5 participants