-
Notifications
You must be signed in to change notification settings - Fork 2.6k
cargo doc: Add --publish-dir option #10100
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
cargo doc: Add --publish-dir option #10100
Conversation
r? @ehuss (rust-highfive has picked a reviewer for you, use r? to override) |
ceb9740
to
5e833ba
Compare
Thanks for the PR! The team talked about this a bit, and we had a few comments:
|
I can chime into this from my perspective. Yes, this is exactly like As for what that use-case is, for me at least the hope is to encode information about where other tools look for documentation directly into Cargo's configuration so that users can just run |
I've tagged this as waiting-on-author now as the consensus seems to be that if we are to implement a feature such as this it would be done with |
Closing per the conversation above about not wishing to add a new flag for this. |
Resolves #10089
The PR adds a new option to
cargo doc
/cargo rustdoc
:--publish-dir
When using this new option, the generated documentation will be copied to the specified publish directory.
This can be used to publish documentation straight into, for example, a directory that is being served up by a local web server already.