From d7d66bd74f2ef1bc8903b15df630ddbb8fe97df4 Mon Sep 17 00:00:00 2001 From: Dario Nieuwenhuis Date: Thu, 1 Jun 2023 00:15:37 +0200 Subject: [PATCH] Document w5500, cyw43 --- .github/ci/doc.sh | 3 +++ cyw43-pio/Cargo.toml | 5 +++++ cyw43/Cargo.toml | 6 ++++++ embassy-net-w5500/Cargo.toml | 5 +++++ 4 files changed, 19 insertions(+) diff --git a/.github/ci/doc.sh b/.github/ci/doc.sh index 7f7dfaa03..736249368 100755 --- a/.github/ci/doc.sh +++ b/.github/ci/doc.sh @@ -29,6 +29,9 @@ docserver-builder -i ./embassy-time -o crates/embassy-time/git.zup docserver-builder -i ./embassy-usb -o crates/embassy-usb/git.zup docserver-builder -i ./embassy-usb-driver -o crates/embassy-usb-driver/git.zup docserver-builder -i ./embassy-usb-logger -o crates/embassy-usb-logger/git.zup +docserver-builder -i ./cyw43 -o crates/cyw43/git.zup +docserver-builder -i ./cyw43-pio -o crates/cyw43-pio/git.zup +docserver-builder -i ./embassy-net-w5500 -o crates/embassy-net-w5500/git.zup export KUBECONFIG=/ci/secrets/kubeconfig.yml POD=$(kubectl -n embassy get po -l app=docserver -o jsonpath={.items[0].metadata.name}) diff --git a/cyw43-pio/Cargo.toml b/cyw43-pio/Cargo.toml index 6e9e784a0..14c07178f 100644 --- a/cyw43-pio/Cargo.toml +++ b/cyw43-pio/Cargo.toml @@ -15,3 +15,8 @@ pio-proc = "0.2" pio = "0.2.1" fixed = "1.23.1" defmt = { version = "0.3", optional = true } + +[package.metadata.embassy_docs] +src_base = "https://github.com/embassy-rs/embassy/blob/cyw43-pio-v$VERSION/cyw43-pio/src/" +src_base_git = "https://github.com/embassy-rs/embassy/blob/$COMMIT/cyw43-pio/src/" +target = "thumbv6m-none-eabi" diff --git a/cyw43/Cargo.toml b/cyw43/Cargo.toml index c7f8816f5..61caa0272 100644 --- a/cyw43/Cargo.toml +++ b/cyw43/Cargo.toml @@ -26,3 +26,9 @@ futures = { version = "0.3.17", default-features = false, features = ["async-awa embedded-hal-1 = { package = "embedded-hal", version = "1.0.0-alpha.10" } num_enum = { version = "0.5.7", default-features = false } + +[package.metadata.embassy_docs] +src_base = "https://github.com/embassy-rs/embassy/blob/cyw43-v$VERSION/cyw43/src/" +src_base_git = "https://github.com/embassy-rs/embassy/blob/$COMMIT/cyw43/src/" +target = "thumbv6m-none-eabi" +features = ["defmt", "firmware-logs"] \ No newline at end of file diff --git a/embassy-net-w5500/Cargo.toml b/embassy-net-w5500/Cargo.toml index 3f19e3d39..37d15c7ac 100644 --- a/embassy-net-w5500/Cargo.toml +++ b/embassy-net-w5500/Cargo.toml @@ -14,3 +14,8 @@ embassy-net-driver-channel = { version = "0.1.0", path = "../embassy-net-driver- embassy-time = { version = "0.1.0" } embassy-futures = { version = "0.1.0" } defmt = { version = "0.3", optional = true } + +[package.metadata.embassy_docs] +src_base = "https://github.com/embassy-rs/embassy/blob/embassy-net-w5500-v$VERSION/embassy-net-w5500/src/" +src_base_git = "https://github.com/embassy-rs/embassy/blob/$COMMIT/embassy-net-w5500/src/" +target = "thumbv7em-none-eabi" \ No newline at end of file