docs: broken links to deps

elpiel commented 1 year ago

I found a few things in the docs and wanted to report them (I could look into fixing them):

[x] embassy-net does not build with the udp feature (the only feature not included in the docs)
[ ] https://docs.embassy.dev/embassy-lora/git/stm32wl/stm32wl/struct.SubGhzRadioConfig.html has fields that point to bad links like: https://docs.embassy.dev/__DOCSERVER_DEPLINK/embassy-stm32/embassy_stm32/subghz/reg_mode/enum.RegMode.html which is not a valid link to the docs of embassy-stm32 crate. This could be because embassy-stm32 docs are not built with the subghz feature and Cargo.toml says it's a todo:

ceekdee commented 1 year ago

SubGhzRadioConfig is no longer referenced after the removal of the original stm32wl LoRa driver in embassy-lora as part of PR https://github.com/embassy-rs/embassy/pull/1407.

Dirbaio commented 1 year ago

True! I'm leaving this issue open because it actually affects all links to deps that are not on docs.rs.

elpiel commented 1 year ago

@Dirbaio keep in mind that there's also an issue with crates.io dependencies where the same crate is used with multiple versions:

Dirbaio commented 8 months ago

inter-crate links are now fixed.

i'm still not sure what's up with the embedded-hal versions, it might be a rustdoc bug?

elpiel commented 8 months ago

Thank you!

embassy-rs / embassy