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

Xtask/latest redirect #3231

Merged
merged 4 commits into from
Mar 7, 2025
Merged

Xtask/latest redirect #3231

merged 4 commits into from
Mar 7, 2025

Conversation

bjoernQ
Copy link
Contributor

@bjoernQ bjoernQ commented Mar 6, 2025

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 📝

  • I have updated existing examples or added new ones (if applicable).
  • I have used cargo xtask fmt-packages command to ensure that all changed code is formatted correctly.
  • My changes were added to the CHANGELOG.md in the proper section.
  • I have added necessary changes to user code to the Migration Guide.
  • My changes are in accordance to the esp-rs developer guidelines

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

cargo xtask build-documentation --chips=esp32c6 --chips=esp32c3
cargo xdoc build-documentation-index --serve

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/

@bjoernQ bjoernQ added the skip-changelog No changelog modification needed label Mar 6, 2025
Copy link
Member

@SergioGasquez SergioGasquez left a 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.tomls to point tat the crate documentation instead of the landing page.

@bjoernQ bjoernQ marked this pull request as ready for review March 7, 2025 10:05
@bjoernQ
Copy link
Contributor Author

bjoernQ commented Mar 7, 2025

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

Copy link
Member

@SergioGasquez SergioGasquez left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! Thanks

@bugadani bugadani added this pull request to the merge queue Mar 7, 2025
Merged via the queue into esp-rs:main with commit 38eb5ae Mar 7, 2025
27 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
skip-changelog No changelog modification needed
Projects
None yet
3 participants