Can't build documentation about esp-wifi-sys HOT 7 CLOSED

We have the updates merged so you should be able to run cargo doc --no-deps --open --target riscv32imc-unknown-none-elf --features "esp32c3,ble,wifi,embedded-svc"

It works, one only needs to "+nightly" that cmd of yours :
cargo "+nightly" doc --no-deps --open --target riscv32imc-unknown-none-elf --features "esp32c3,ble,wifi,embedded-svc"

TYVM !

from esp-wifi-sys.

It would work if you pass the target and the requested features but unfortunately you also run into another issue here:

The currently published HALs for RISCV targets depend on a yanked version of the riscv crate which makes it unable to build (unless you happened to build it before that happened and have a Cargo.lock file locally). If you are targeting one of the Xtensa chips it should work

If you are targeting a RISCV based chip the bad thing, is you can't just use the HAL as a git dependency (it's fixed there) since there are breaking changes which need to get adapted here (I already started but didn't finish that)

from esp-wifi-sys.

It doesn't seem to work with a target either, that's what I get : error: failed to run rustc to learn about target-specific information
rustc --print target-list does not show xtensa targets though, maybe I'm missing sth here.
Does that mean that documentation is currently completely unavailable ? I'm trying to use Wifi on a RISCV-based device...

from esp-wifi-sys.

Do you set an Xtensa target maybe?

This would create docs
cargo doc --no-deps --open --target riscv32imc-unknown-none-elf --features "esp32c3,ble,wifi,embedded-svc"

But as said you will hit the problem of the yanked riscv crate.

You could try to place the attached lock file side by side to Cargo.toml - not sure if that will work - I never tried it

Cargo.lock.zip

from esp-wifi-sys.

No luck with that Cargo.lock file either :(

from esp-wifi-sys.

I hope to get all the changes needed for the upcoming HAL version done and available on a separate branch soon

from esp-wifi-sys.

We have the updates merged so you should be able to run
cargo doc --no-deps --open --target riscv32imc-unknown-none-elf --features "esp32c3,ble,wifi,embedded-svc"

from esp-wifi-sys.