search

stm32-rs / stm32h7xx-hal

Peripheral access API for STM32H7 series microcontrollers
BSD Zero Clause License
227 stars 104 forks source link

Documentation build is failing. #52

Closed david-boles closed 4 years ago

david-boles commented 4 years ago

Hello, hopefully this isn't a known issue somewhere else. https://docs.rs/crate/stm32h7xx-hal/0.3.0

richardeoin commented 4 years ago

Hey, welcome and thank you for the issue! This is a result of a known change in docs.rs, but should absolutely be linked or described here too.

This issue is the best place to start. It looks like there isn't an ideal solution yet, but a PR with a workaround or partial solution for the next release would be very welcome.

It's also possible to run cargo doc locally

git clone https://github.com/stm32-rs/stm32h7xx-hal.git
cd stm32h7xx-hal
cargo doc --features rt,stm32h743
david-boles commented 4 years ago

@richardeoin Reading through that, I don't know how I would implement a workaround (I'm effectively completely new to Rust which doesn't help) but if there's something I'm missing I'd be happy to try. Thanks for the local solution!

richardeoin commented 4 years ago

No problem! I've tagged the v0.4.0 milestone so this gets reviewed before the next release

richardeoin commented 4 years ago

Now fixed 🎉 More information here: https://blog.rust-lang.org/2020/03/15/docs-rs-opt-into-fewer-targets.html