rust-embedded / embedded-hal

A Hardware Abstraction Layer (HAL) for embedded systems
Apache License 2.0
1.95k stars 197 forks source link

Broken documentation for GPIO23 #454

Closed VorpalBlade closed 1 year ago

VorpalBlade commented 1 year ago

According to rust-analyzer I'm getting a Gpio23 object (which makes sense, I'm trying to hook up a LED to that GPIO for a test). When I try to find documentation for it however at https://esp-rs.github.io/esp-idf-hal/esp_idf_hal/gpio/index.html it only goes up to Gpio21!?

I presume this is due to this docs being built for a different module, but on docs.rs there is a dropdown to switch between build targets. It would be really useful to have that here.

For context: I'm using and targeting a traditional Xtensa ESP32 module (ESP32-WROVER-IE specifically on a ESP32-DevKitC, this was the only dev board with I2S support and traditional non-LE Bluetooth I could find in stock here in Sweden).

EDIT: Running cargo doc to locally build the docs doesn't work either. the esp-idf crates are completely missing from the docs in this case! EDIT 2: Apparently cargo splits docs up in target/doc and target/xtensa-esp32-espidf/doc. So the docs were generated. Didn't know that was a thing. I guess target/doc is proc macros and build stuff that runs on the host?

Dirbaio commented 1 year ago

You should file this issue at https://github.com/esp-rs/esp-idf-hal/

VorpalBlade commented 1 year ago

Sorry, too many tabs open while trying to figure out the mess that is embedded rust.