-
Notifications
You must be signed in to change notification settings - Fork 264
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
Xtask/latest redirect #3231
Xtask/latest redirect #3231
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I guess before merging this we should update the documentation
field in the Cargo.toml
s to point tat the crate documentation instead of the landing page.
Marking this as RFR - I'm a bit afraid we (at least I) don't have a real way to test this end-to-end and maybe I don't completely understand the doc-generation process in depth |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM! Thanks
Thank you for your contribution!
We appreciate the time and effort you've put into this pull request.
To help us review it efficiently, please ensure you've gone through the following checklist:
Submission Checklist 📝
cargo xtask fmt-packages
command to ensure that all changed code is formatted correctly.CHANGELOG.md
in the proper section.Extra:
Pull Request Details 📖
Description
Based on #3228
This makes it possible to get documentation via URLs like
.../esp-hal/latest/
to the latest created documentation version.(apparently we have a redirect from e.g. https://docs.espressif.com/projects/rust/xtensa-lx-rt/ to https://docs.espressif.com/projects/rust/xtensa-lx-rt/latest/ )
Should resolve #3198
It also fixes the screwed-up naming of xtensa-lx-rt-proc-macros (which was causing problem generating the documentation)
Testing
Try the above mentioned url - e.g. http://127.0.0.1:8000/esp-hal/latest/ or http://127.0.0.1:8000/esp-println/latest/