docs.rs build not working

[dfrankland]

Error log from docs.rs

Related: stm32-rs/stm32f1xx-hal#154

Reported by @strom-und-spiele: #45 (comment)

Likely caused by the addition of this:

stm32f3xx-hal/.cargo/config

Line 8 in 7e0d7e6

target = "thumbv7em-none-eabihf"

[dfrankland]

We can change the default-target to thumbv7m-none-eabi, but docs.rs does not support it yet.

  [package.metadata.docs.rs]
  features = ["stm32f103", "rt", "stm32-usbd"]
+ default-target = "thumbv7m-none-eabi"

Until that's added, does anyone see issues with making default-target = "x86_64-unknown-linux-gnu"?

[dfrankland]

Related docs.rs issues:
rust-lang/docs.rs#343

[strom-und-spiele]

As we currently don't have a [package.metadata.docs.rs] section, I don't see any harm in adding it. I'd suggest building for the discovery board as we provide all examples for it.

Does this one sum it up?

[package.metadata.docs.rs]
features = ["stm32f3DISCOVERY", "rt"]
# thumbv7m-none-eabi is not a supported target on docs.rs,
# however the target is not relevant for docs.
default-target = "x86_64-unknown-linux-gnu"

[dfrankland]

We do have a section here:

stm32f3xx-hal/Cargo.toml

Line 13 in 7e0d7e6

[package.metadata.docs.rs]

I think the comment you wrote also makes sense to add. stm32f3DISCOVERY isn't a feature though, so I am not too sure on that.

[strom-und-spiele]

Ah sorry, was falsely checking the .cargo/config file.
I added the stm32f3DISCOVERY feature a while ago when working with the adc Module (as I found it more convenient; https://github.com/stm32-rs/stm32f3xx-hal/pull/47/files#diff-80398c5faae3c069e4e6aa2ed11b28c0R52 ) Sorry for the confusion.

[Disasm]

Seems to be a bug in docs.rs, because it tries building on the default target, but does not fetch a rustup target for it. Adding default-target = "x86_64-unknown-linux-gnu" should help.

[rubberduck203]

I was able to confirm that the approach of the default target to the package meta-data works.

[package.metadata.docs.rs]
default-target = "x86_64-unknown-linux-gnu"

https://docs.rs/crate/stm32f3-discovery/0.1.3/source/Cargo.toml