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

docs: broken links to deps #1108

Closed
1 of 2 tasks
elpiel opened this issue Dec 11, 2022 · 5 comments
Closed
1 of 2 tasks

docs: broken links to deps #1108

elpiel opened this issue Dec 11, 2022 · 5 comments

Comments

@elpiel
Copy link
Contributor

elpiel commented Dec 11, 2022

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

  • 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:

[package.metadata.embassy_docs]
src_base = "https://github.com/embassy-rs/embassy/blob/embassy-stm32-v$VERSION/embassy-stm32/src/"
src_base_git = "https://github.com/embassy-rs/embassy/blob/$COMMIT/embassy-stm32/src/"
# TODO: sdmmc
# TODO: net
# TODO: subghz
features = ["nightly", "defmt", "unstable-pac", "unstable-traits", "exti", "time-driver-any"]

@ceekdee
Copy link
Contributor

ceekdee commented Apr 30, 2023

SubGhzRadioConfig is no longer referenced after the removal of the original stm32wl LoRa driver in embassy-lora as part of PR #1407.

@Dirbaio Dirbaio removed the e-lora label May 1, 2023
@Dirbaio Dirbaio changed the title Docs build features docs: broken links to deps May 1, 2023
@Dirbaio
Copy link
Member

Dirbaio commented May 1, 2023

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

@elpiel
Copy link
Contributor Author

elpiel commented May 1, 2023

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

embassy-rs/docserver#2

@Dirbaio
Copy link
Member

Dirbaio commented Dec 13, 2023

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?

@Dirbaio Dirbaio closed this as completed Dec 13, 2023
@elpiel
Copy link
Contributor Author

elpiel commented Dec 13, 2023

Thank you!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants