usb-dfu: add docs metadata.

This commit is contained in:
Dario Nieuwenhuis 2024-01-26 14:23:51 +01:00
parent 73cfa8f8a9
commit adb024bdbe
2 changed files with 13 additions and 3 deletions

2
.github/ci/doc.sh vendored
View file

@ -1,7 +1,7 @@
#!/bin/bash
## on push branch=main
set -euo pipefail
set -euxo pipefail
export RUSTUP_HOME=/ci/cache/rustup
export CARGO_HOME=/ci/cache/cargo

View file

@ -12,14 +12,24 @@ categories = [
"asynchronous"
]
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
[package.metadata.embassy_docs]
src_base = "https://github.com/embassy-rs/embassy/blob/embassy-usb-v$VERSION/embassy-usb-dfu/src/"
src_base_git = "https://github.com/embassy-rs/embassy/blob/$COMMIT/embassy-usb-dfu/src/"
features = ["defmt", "cortex-m"]
target = "thumbv7em-none-eabi"
flavors = [
{ name = "dfu", features = [ "dfu" ] },
{ name = "application", features = [ "application" ] },
]
[package.metadata.docs.rs]
features = ["defmt", "cortex-m", "dfu"]
[dependencies]
bitflags = "2.4.1"
cortex-m = { version = "0.7.7", features = ["inline-asm"], optional = true }
defmt = { version = "0.3.5", optional = true }
embassy-boot = { version = "0.2.0", path = "../embassy-boot" }
# embassy-embedded-hal = { version = "0.1.0", path = "../embassy-embedded-hal" }
embassy-futures = { version = "0.1.1", path = "../embassy-futures" }
embassy-sync = { version = "0.5.0", path = "../embassy-sync" }
embassy-time = { version = "0.3.0", path = "../embassy-time" }