-
Notifications
You must be signed in to change notification settings - Fork 2.4k
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
Insert package name/version in API docs #1681
Comments
So what is the best solution for handling this?
|
I would say 2 should be the way to go. |
fwiw worth, these env vars should be available to any cargo triggered process, included |
Those that still don't use docs.rs like https://docs.serde.rs/serde/ or other big projects -- I would still like to see the crate version right in their API doc, so if rustdoc or cargo makes this easy to do, we could see it more even in the projects that host their own docs. |
I've noticed that there is already an unstable option in I added a corresponding unstable option to cargo. Thanks @ehuss for providing some guidance over Discord's #cargo channel. This is my first issue in cargo project, so feedback would be very appreciated! |
Add an option to include crate versions to the generated docs Fixes #1681
Find a way to insert package name/version in generated docs by
cargo doc
.Currently I use
sed
to add the version of my package to the title of all doc pages. Adding this feature to cargo would spread this convention further, which would be useful, and I wouldn't have to use make & sed to script it 😄The text was updated successfully, but these errors were encountered: