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

Generate a docset from the cargo build cache #31

Open
Robzz opened this issue Apr 29, 2021 · 0 comments
Open

Generate a docset from the cargo build cache #31

Robzz opened this issue Apr 29, 2021 · 0 comments
Labels
T: enhancement New feature or request

Comments

@Robzz
Copy link
Owner

Robzz commented Apr 29, 2021

Is your feature request related to a problem? Please describe.
There currently is no way of generating the docsets for multiple crates at once unless those crates are part of the same workspace.

Describe the solution you'd like
Generate docsets for many crates at once by leveraging the cargo build cache. cargo-docset would have to run over the whole build cache. It should also be possible to generate a single docset containing the documentation for the whole build cache. Gotta play with the build cache a bit before settling on how to do this, since I've never really used it.

Additional context
What should the feature look like from a UX perspective ? We could expand the generate command to make it able to achieve this, but it needs to behave so differently in this situation that I'm thinking it might be better as a different command, say generate-cache. The user could then use this feature with the following invocation: cargo docset generate-cache <options>.
The generate command would remain the default, and the simple cargo docset invocation would behave the same as it currently does.

I need to at the very least sleep on this though :)

@Robzz Robzz added the T: enhancement New feature or request label Apr 29, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
T: enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant