aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authori509VCB <[email protected]>2025-03-19 13:05:10 -0500
committeri509VCB <[email protected]>2025-03-19 13:05:10 -0500
commit9afb385f6d92149ff15cf03c3bfaa8cb512a6191 (patch)
tree00e0cc5116ef03ed9cddd324f8274959a3d287ca
parentf7f316ad179a1812ffa3f10869165bafc99d515e (diff)
Add docs related things
-rwxr-xr-x.github/ci/doc.sh1
-rw-r--r--README.md1
-rw-r--r--docs/pages/overview.adoc1
-rw-r--r--embassy-mspm0/Cargo.toml8
4 files changed, 10 insertions, 1 deletions
diff --git a/.github/ci/doc.sh b/.github/ci/doc.sh
index c92892406..58ffe5f2e 100755
--- a/.github/ci/doc.sh
+++ b/.github/ci/doc.sh
@@ -25,6 +25,7 @@ docserver-builder -i ./embassy-executor -o webroot/crates/embassy-executor/git.z
25docserver-builder -i ./embassy-futures -o webroot/crates/embassy-futures/git.zup 25docserver-builder -i ./embassy-futures -o webroot/crates/embassy-futures/git.zup
26docserver-builder -i ./embassy-nrf -o webroot/crates/embassy-nrf/git.zup 26docserver-builder -i ./embassy-nrf -o webroot/crates/embassy-nrf/git.zup
27docserver-builder -i ./embassy-rp -o webroot/crates/embassy-rp/git.zup 27docserver-builder -i ./embassy-rp -o webroot/crates/embassy-rp/git.zup
28docserver-builder -i ./embassy-mspm0 -o webroot/crates/embassy-mspm0/git.zup
28docserver-builder -i ./embassy-sync -o webroot/crates/embassy-sync/git.zup 29docserver-builder -i ./embassy-sync -o webroot/crates/embassy-sync/git.zup
29docserver-builder -i ./cyw43 -o webroot/crates/cyw43/git.zup 30docserver-builder -i ./cyw43 -o webroot/crates/cyw43/git.zup
30docserver-builder -i ./cyw43-pio -o webroot/crates/cyw43-pio/git.zup 31docserver-builder -i ./cyw43-pio -o webroot/crates/cyw43-pio/git.zup
diff --git a/README.md b/README.md
index ee5c42245..a682927c8 100644
--- a/README.md
+++ b/README.md
@@ -15,6 +15,7 @@ Rust's <a href="https://rust-lang.github.io/async-book/">async/await</a> allows
15 - <a href="https://docs.embassy.dev/embassy-stm32/">embassy-stm32</a>, for all STM32 microcontroller families. 15 - <a href="https://docs.embassy.dev/embassy-stm32/">embassy-stm32</a>, for all STM32 microcontroller families.
16 - <a href="https://docs.embassy.dev/embassy-nrf/">embassy-nrf</a>, for the Nordic Semiconductor nRF52, nRF53, nRF54 and nRF91 series. 16 - <a href="https://docs.embassy.dev/embassy-nrf/">embassy-nrf</a>, for the Nordic Semiconductor nRF52, nRF53, nRF54 and nRF91 series.
17 - <a href="https://docs.embassy.dev/embassy-rp/">embassy-rp</a>, for the Raspberry Pi RP2040 and RP23xx microcontrollers. 17 - <a href="https://docs.embassy.dev/embassy-rp/">embassy-rp</a>, for the Raspberry Pi RP2040 and RP23xx microcontrollers.
18 - <a href="https://docs.embassy.dev/embassy-mspm0/">embassy-mspm0</a>, for the Texas Instruments MSPM0 microcontrollers.
18 - <a href="https://github.com/esp-rs">esp-rs</a>, for the Espressif Systems ESP32 series of chips. 19 - <a href="https://github.com/esp-rs">esp-rs</a>, for the Espressif Systems ESP32 series of chips.
19 - Embassy HAL support for Espressif chips, as well as Async WiFi, Bluetooth and ESP-NOW, is being developed in the [esp-rs/esp-hal](https://github.com/esp-rs/esp-hal) repository. 20 - Embassy HAL support for Espressif chips, as well as Async WiFi, Bluetooth and ESP-NOW, is being developed in the [esp-rs/esp-hal](https://github.com/esp-rs/esp-hal) repository.
20 - <a href="https://github.com/ch32-rs/ch32-hal">ch32-hal</a>, for the WCH 32-bit RISC-V(CH32V) series of chips. 21 - <a href="https://github.com/ch32-rs/ch32-hal">ch32-hal</a>, for the WCH 32-bit RISC-V(CH32V) series of chips.
diff --git a/docs/pages/overview.adoc b/docs/pages/overview.adoc
index 9b93ba10c..333a5dd9f 100644
--- a/docs/pages/overview.adoc
+++ b/docs/pages/overview.adoc
@@ -29,6 +29,7 @@ The Embassy project maintains HALs for select hardware, but you can still use HA
29* link:https://docs.embassy.dev/embassy-stm32/[embassy-stm32], for all STM32 microcontroller families. 29* link:https://docs.embassy.dev/embassy-stm32/[embassy-stm32], for all STM32 microcontroller families.
30* link:https://docs.embassy.dev/embassy-nrf/[embassy-nrf], for the Nordic Semiconductor nRF52, nRF53, nRF91 series. 30* link:https://docs.embassy.dev/embassy-nrf/[embassy-nrf], for the Nordic Semiconductor nRF52, nRF53, nRF91 series.
31* link:https://docs.embassy.dev/embassy-rp/[embassy-rp], for the Raspberry Pi RP2040 microcontroller. 31* link:https://docs.embassy.dev/embassy-rp/[embassy-rp], for the Raspberry Pi RP2040 microcontroller.
32* link:https://docs.embassy.dev/embassy-mspm0/[embassy-mspm0], for the Texas Instruments MSPM0 microcontrollers.
32* link:https://github.com/esp-rs[esp-rs], for the Espressif Systems ESP32 series of chips. 33* link:https://github.com/esp-rs[esp-rs], for the Espressif Systems ESP32 series of chips.
33* link:https://github.com/ch32-rs/ch32-hal[ch32-hal], for the WCH 32-bit RISC-V(CH32V) series of chips. 34* link:https://github.com/ch32-rs/ch32-hal[ch32-hal], for the WCH 32-bit RISC-V(CH32V) series of chips.
34* link:https://github.com/AlexCharlton/mpfs-hal[mpfs-hal], for the Microchip PolarFire SoC. 35* link:https://github.com/AlexCharlton/mpfs-hal[mpfs-hal], for the Microchip PolarFire SoC.
diff --git a/embassy-mspm0/Cargo.toml b/embassy-mspm0/Cargo.toml
index 0f4092d8a..cfe0c85a9 100644
--- a/embassy-mspm0/Cargo.toml
+++ b/embassy-mspm0/Cargo.toml
@@ -9,6 +9,12 @@ categories = ["embedded", "hardware-support", "no-std", "asynchronous"]
9repository = "https://github.com/embassy-rs/embassy" 9repository = "https://github.com/embassy-rs/embassy"
10documentation = "https://docs.embassy.dev/embassy-mspm0" 10documentation = "https://docs.embassy.dev/embassy-mspm0"
11 11
12[package.metadata.embassy_docs]
13src_base = "https://github.com/embassy-rs/embassy/blob/embassy-mspm0-v$VERSION/embassy-mspm0/src/"
14src_base_git = "https://github.com/embassy-rs/embassy/blob/$COMMIT/embassy-mspm0/src/"
15
16features = ["defmt", "unstable-pac", "time-driver-any"]
17
12[package.metadata.docs.rs] 18[package.metadata.docs.rs]
13features = ["defmt", "unstable-pac", "time-driver-any", "time", "mspm0g3507"] 19features = ["defmt", "unstable-pac", "time-driver-any", "time", "mspm0g3507"]
14rustdoc-args = ["--cfg", "docsrs"] 20rustdoc-args = ["--cfg", "docsrs"]
@@ -105,7 +111,7 @@ time-driver-tima0 = ["_time-driver"]
105time-driver-tima1 = ["_time-driver"] 111time-driver-tima1 = ["_time-driver"]
106 112
107#! ## Chip-selection features 113#! ## Chip-selection features
108#! Select your chip by specifying the model as a feature, e.g. `mspm0g3507`. 114#! Select your chip by specifying the model as a feature, e.g. `mspm0g350x`.
109#! Check the `Cargo.toml` for the latest list of supported chips. 115#! Check the `Cargo.toml` for the latest list of supported chips.
110#! 116#!
111#! **Important:** Do not forget to adapt the target chip in your toolchain, 117#! **Important:** Do not forget to adapt the target chip in your toolchain,