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

rustdoc: Show package version in the generated documentation when invoked through cargo doc #3295

Closed
crumblingstatue opened this issue Nov 15, 2016 · 5 comments

Comments

@crumblingstatue
Copy link

It would be useful for users to know for which version of a package they are reading the documentation for.

This would be especially helpful in identifying outdated documentation online, which there is an abundance of.

Moved from rust-lang/rust#29275 due to request.

@alexcrichton
Copy link
Member

Does rustdoc have the ability to do this? AFAIK we'd need to expose a flag to rustdoc first.

@crumblingstatue
Copy link
Author

I don't think rustdoc has the ability to do this, which is why I opened this issue at rust-lang/rust, but @steveklabnik closed the issue there, requesting it to be moved here.

@alexcrichton
Copy link
Member

Ok... well it's at least a todo item here!

@steveklabnik
Copy link
Member

I thought rustdoc had the ability to control output directly already; in the end, even if rustdoc needs some support, it will need cargo to actually do the right thing here, since rustdoc can't know version info.

@ehuss
Copy link
Contributor

ehuss commented Mar 3, 2020

This has been implemented, stabilization is tracked in #7907.

@ehuss ehuss closed this as completed Mar 3, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants