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

Broken documentation builds for esp-storage and esp-lp-hal #2857

Closed
Be-ing opened this issue Dec 20, 2024 · 3 comments
Closed

Broken documentation builds for esp-storage and esp-lp-hal #2857

Be-ing opened this issue Dec 20, 2024 · 3 comments
Labels
bug Something isn't working status:needs-attention This should be prioritized

Comments

@Be-ing
Copy link

Be-ing commented Dec 20, 2024

Bug description

This repository has a variety of crates in it, but only documentation for esp(-idf)-hal and esp-wifi are published on https://docs.esp-rs.org/esp-hal/ The other crates are failing to build on docs.rs with a variety of errors, for example:

https://docs.rs/crate/esp-hal-smartled/0.13.0/builds/1341613
https://docs.rs/crate/esp-idf-servo/0.2.4/builds/842060

@Be-ing Be-ing added bug Something isn't working status:needs-attention This should be prioritized labels Dec 20, 2024
@Be-ing Be-ing changed the title Missing documentation for crates besides hal and wifi Missing documentation for crates besides esp-(idf-)hal and esp-wifi Dec 20, 2024
@bugadani
Copy link
Contributor

bugadani commented Dec 20, 2024

We host documentation for the crates that have differences based on the chips you might use. This does not include community maintained crates like esp-hal-smartled, or esp-idf based crates, especially not ones that we have no relations to.

@bugadani bugadani closed this as not planned Won't fix, can't repro, duplicate, stale Dec 20, 2024
@github-project-automation github-project-automation bot moved this from Todo to Done in esp-rs Dec 20, 2024
@Be-ing
Copy link
Author

Be-ing commented Dec 20, 2024

Ah, sorry my bad. I saw some of those crates (namely esp-hal-smartled) were maintained by Espressif on crates.io and assumed they were in this repository. Most of the crates in this repository are indeed building on docs.rs. However, two crates in this repository do have broken documentation builds on docs.rs: esp-storage and esp-lp-hal.

@Be-ing Be-ing changed the title Missing documentation for crates besides esp-(idf-)hal and esp-wifi Broken documentation builds for esp-storage and esp-lp-hal Dec 20, 2024
@Be-ing
Copy link
Author

Be-ing commented Dec 20, 2024

Another layer of confusion: crates.io lists esp-hal-smartled's repository as this repository, but it has been moved to https://github.com/esp-rs/esp-hal-community and hasn't had a release to crates.io since the code was moved to the other repository 🙃

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working status:needs-attention This should be prioritized
Projects
Status: Done
Development

No branches or pull requests

2 participants