mirror of
https://github.com/esp-rs/esp-hal.git
synced 2025-09-27 12:20:56 +00:00
Add docsrs metadata and warning for esp-lp-hal (#3587)
This commit is contained in:
parent
1767e74cb6
commit
1e839e3711
@ -10,6 +10,11 @@ categories = ["embedded", "hardware-support", "no-std"]
|
||||
repository = "https://github.com/esp-rs/esp-hal"
|
||||
license = "MIT OR Apache-2.0"
|
||||
|
||||
[package.metadata.docs.rs]
|
||||
default-target = "riscv32imac-unknown-none-elf"
|
||||
features = ["esp32c6"]
|
||||
rustdoc-args = ["--cfg", "docsrs"]
|
||||
|
||||
[lib]
|
||||
bench = false
|
||||
test = false
|
||||
|
@ -1,3 +1,7 @@
|
||||
#![cfg_attr(
|
||||
all(docsrs, not(not_really_docsrs)),
|
||||
doc = "<div style='padding:30px;background:#810;color:#fff;text-align:center;'><p>You might want to <a href='https://docs.espressif.com/projects/rust/'>browse the <code>esp-lp-hal</code> documentation on the esp-rs website</a> instead.</p><p>The documentation here on <a href='https://docs.rs'>docs.rs</a> is built for a single chip only (ESP32-C6, in particular), while on the esp-rs website you can select your exact chip from the list of supported devices. Available peripherals and their APIs change depending on the chip.</p></div>\n\n<br/>\n\n"
|
||||
)]
|
||||
//! Bare-metal (`no_std`) HAL for the low power and ultra-low power cores found
|
||||
//! in some Espressif devices. Where applicable, drivers implement the
|
||||
//! [embedded-hal] traits.
|
||||
|
Loading…
x
Reference in New Issue
Block a user