Update documentation links (#3197)

* feat: Update documentation links * feat: Add documentation field to Cargo.toml
esp-rs · Mar 3, 2025 · 3816de0 · 3816de0
1 parent a71c67b
commit 3816de0
Show file tree

Hide file tree

Showing 20 changed files with 158 additions and 148 deletions.
diff --git a/README.md b/README.md
@@ -45,7 +45,7 @@ For information about the HAL and how to use it in your own projects, please ref
 When browsing the examples, we recommend viewing the tag for the `esp-hal` release you are using to ensure compatibility, e.g. [esp-hal-v1.0.0-beta.0], as the `main` branch is used for development and APIs may have changed in the meantime.
 
 [The Rust on ESP Book]: https://esp-rs.github.io/book/
-[documentation]: https://docs.esp-rs.org/esp-hal/
+[documentation]: https://docs.espressif.com/projects/rust/
 [esp-hal-v1.0.0-beta.0]: https://github.com/esp-rs/esp-hal/tree/esp-hal-v1.0.0-beta.0/examples
 
 ## Resources

diff --git a/esp-alloc/Cargo.toml b/esp-alloc/Cargo.toml
@@ -1,13 +1,14 @@
 [package]
-name         = "esp-alloc"
-version      = "0.7.0"
-edition      = "2021"
-rust-version = "1.84.0"
-description  = "A heap allocator for Espressif devices"
-keywords     = ["allocator", "embedded", "esp32", "espressif", "memory"]
-categories   = ["embedded", "memory-management", "no-std"]
-repository   = "https://github.com/esp-rs/esp-hal"
-license      = "MIT OR Apache-2.0"
+name          = "esp-alloc"
+version       = "0.7.0"
+edition       = "2021"
+rust-version  = "1.84.0"
+description   = "A heap allocator for Espressif devices"
+documentation = "https://docs.espressif.com/projects/rust/"
+keywords      = ["allocator", "embedded", "esp32", "espressif", "memory"]
+categories    = ["embedded", "memory-management", "no-std"]
+repository    = "https://github.com/esp-rs/esp-hal"
+license       = "MIT OR Apache-2.0"
 
 [package.metadata.docs.rs]
 default-target = "riscv32imc-unknown-none-elf"

diff --git a/esp-backtrace/Cargo.toml b/esp-backtrace/Cargo.toml
@@ -1,20 +1,21 @@
 [package]
-name         = "esp-backtrace"
-version      = "0.15.1"
-edition      = "2021"
-rust-version = "1.84.0"
-description  = "Bare-metal backtrace support for Espressif devices"
-keywords     = ["backtrace", "embedded", "esp32", "espressif"]
-categories   = ["embedded", "hardware-support", "no-std"]
-repository   = "https://github.com/esp-rs/esp-hal"
-license      = "MIT OR Apache-2.0"
+name          = "esp-backtrace"
+version       = "0.15.1"
+edition       = "2021"
+rust-version  = "1.84.0"
+description   = "Bare-metal backtrace support for Espressif devices"
+documentation = "https://docs.espressif.com/projects/rust/"
+keywords      = ["backtrace", "embedded", "esp32", "espressif"]
+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 = "riscv32imc-unknown-none-elf"
 features       = ["esp32c3", "panic-handler", "exception-handler", "println", "esp-println/uart"]
 
 [dependencies]
-defmt       = { version = "0.3.10",  optional = true }
+defmt       = { version = "0.3.10", optional = true }
 esp-println = { version = "0.13.0", optional = true, default-features = false, path = "../esp-println" }
 semihosting = { version = "0.1.18", optional = true }
 
@@ -24,7 +25,6 @@ esp-build = { version = "0.2.0", path = "../esp-build" }
 [features]
 default = ["colors"]
 
-# You must enable exactly one of the below features to support the correct chip:
 esp32   = ["esp-println?/esp32", "semihosting?/openocd-semihosting", "print-float-registers"]
 esp32c2 = ["esp-println?/esp32c2"]
 esp32c3 = ["esp-println?/esp32c3"]

diff --git a/esp-build/Cargo.toml b/esp-build/Cargo.toml
@@ -1,11 +1,12 @@
 [package]
-name         = "esp-build"
-version      = "0.2.0"
-edition      = "2021"
-rust-version = "1.84.0"
-description  = "Build utilities for esp-hal"
-repository   = "https://github.com/esp-rs/esp-hal"
-license      = "MIT OR Apache-2.0"
+name          = "esp-build"
+version       = "0.2.0"
+edition       = "2021"
+rust-version  = "1.84.0"
+description   = "Build utilities for esp-hal"
+documentation = "https://docs.espressif.com/projects/rust/"
+repository    = "https://github.com/esp-rs/esp-hal"
+license       = "MIT OR Apache-2.0"
 
 [lib]
 proc-macro = true

diff --git a/esp-config/Cargo.toml b/esp-config/Cargo.toml
@@ -1,11 +1,12 @@
 [package]
-name         = "esp-config"
-version      = "0.3.1"
-edition      = "2021"
-rust-version = "1.84.0"
-description  = "Configure projects using esp-hal and related packages"
-repository   = "https://github.com/esp-rs/esp-hal"
-license      = "MIT OR Apache-2.0"
+name          = "esp-config"
+version       = "0.3.1"
+edition       = "2021"
+rust-version  = "1.84.0"
+description   = "Configure projects using esp-hal and related packages"
+documentation = "https://docs.espressif.com/projects/rust/"
+repository    = "https://github.com/esp-rs/esp-hal"
+license       = "MIT OR Apache-2.0"
 
 [dependencies]
 document-features = "0.2.10"

diff --git a/esp-hal-embassy/Cargo.toml b/esp-hal-embassy/Cargo.toml
@@ -1,13 +1,14 @@
 [package]
-name         = "esp-hal-embassy"
-version      = "0.7.0"
-edition      = "2021"
-rust-version = "1.84.0"
-description  = "Embassy support for esp-hal"
-keywords     = ["async", "embedded", "esp32", "espressif"]
-categories   = ["asynchronous", "embedded", "hardware-support", "no-std"]
-repository   = "https://github.com/esp-rs/esp-hal"
-license      = "MIT OR Apache-2.0"
+name          = "esp-hal-embassy"
+version       = "0.7.0"
+edition       = "2021"
+rust-version  = "1.84.0"
+description   = "Embassy support for esp-hal"
+documentation = "https://docs.espressif.com/projects/rust/"
+keywords      = ["async", "embedded", "esp32", "espressif"]
+categories    = ["asynchronous", "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"

diff --git a/esp-hal-procmacros/Cargo.toml b/esp-hal-procmacros/Cargo.toml
@@ -1,11 +1,12 @@
 [package]
-name         = "esp-hal-procmacros"
-version      = "0.17.0"
-edition      = "2021"
-rust-version = "1.84.0"
-description  = "Procedural macros for esp-hal"
-repository   = "https://github.com/esp-rs/esp-hal"
-license      = "MIT OR Apache-2.0"
+name          = "esp-hal-procmacros"
+version       = "0.17.0"
+edition       = "2021"
+rust-version  = "1.84.0"
+description   = "Procedural macros for esp-hal"
+documentation = "https://docs.espressif.com/projects/rust/"
+repository    = "https://github.com/esp-rs/esp-hal"
+license       = "MIT OR Apache-2.0"
 
 [package.metadata.docs.rs]
 features = ["embassy", "has-ulp-core", "interrupt", "ram", "is-ulp-core"]

diff --git a/esp-hal/Cargo.toml b/esp-hal/Cargo.toml
@@ -4,7 +4,7 @@ version       = "1.0.0-beta.0"
 edition       = "2021"
 rust-version  = "1.84.0"
 description   = "Bare-metal HAL for Espressif devices"
-documentation = "https://docs.esp-rs.org/esp-hal/"
+documentation = "https://docs.espressif.com/projects/rust/"
 keywords      = ["embedded", "embedded-hal", "esp32", "espressif", "hal"]
 categories    = ["embedded", "hardware-support", "no-std"]
 repository    = "https://github.com/esp-rs/esp-hal"

diff --git a/esp-hal/README.md b/esp-hal/README.md
@@ -17,7 +17,7 @@ For help getting started with this HAL, please refer to [The Rust on ESP Book] a
 
 ## [Documentation]
 
-[documentation]: https://docs.esp-rs.org/esp-hal/
+[documentation]: https://docs.espressif.com/projects/rust/
 
 ## Supported Devices
 

diff --git a/esp-hal/src/lib.rs b/esp-hal/src/lib.rs
@@ -1,6 +1,6 @@
 #![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.esp-rs.org/esp-hal/'>browse the <code>esp-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"
+    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-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 all Espressif ESP32 devices.
 //!

diff --git a/esp-ieee802154/Cargo.toml b/esp-ieee802154/Cargo.toml
@@ -1,13 +1,14 @@
 [package]
-name         = "esp-ieee802154"
-version      = "0.6.0"
-edition      = "2021"
-rust-version = "1.84.0"
-description  = "Low-level IEEE 802.15.4 driver for the ESP32-C6 and ESP32-H2"
-keywords     = ["embedded", "ieee802154", "esp32", "espressif", "wpan"]
-categories   = ["embedded", "network-programming", "no-std"]
-repository   = "https://github.com/esp-rs/esp-hal"
-license      = "MIT OR Apache-2.0"
+name          = "esp-ieee802154"
+version       = "0.6.0"
+edition       = "2021"
+rust-version  = "1.84.0"
+description   = "Low-level IEEE 802.15.4 driver for the ESP32-C6 and ESP32-H2"
+documentation = "https://docs.espressif.com/projects/rust/"
+keywords      = ["embedded", "esp32", "espressif", "ieee802154", "wpan"]
+categories    = ["embedded", "network-programming", "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"

diff --git a/esp-lp-hal/Cargo.toml b/esp-lp-hal/Cargo.toml
@@ -1,13 +1,14 @@
 [package]
-name         = "esp-lp-hal"
-version      = "0.1.0"
-edition      = "2021"
-rust-version = "1.84.0"
-description  = "HAL for low-power RISC-V coprocessors found in ESP32 devices"
-keywords     = ["embedded", "embedded-hal", "esp32", "espressif", "hal"]
-categories   = ["embedded", "hardware-support", "no-std"]
-repository   = "https://github.com/esp-rs/esp-hal"
-license      = "MIT OR Apache-2.0"
+name          = "esp-lp-hal"
+version       = "0.1.0"
+edition       = "2021"
+rust-version  = "1.84.0"
+description   = "HAL for low-power RISC-V coprocessors found in ESP32 devices"
+documentation = "https://docs.espressif.com/projects/rust/"
+keywords      = ["embedded", "embedded-hal", "esp32", "espressif", "hal"]
+categories    = ["embedded", "hardware-support", "no-std"]
+repository    = "https://github.com/esp-rs/esp-hal"
+license       = "MIT OR Apache-2.0"
 
 [lib]
 bench = false

diff --git a/esp-metadata/Cargo.toml b/esp-metadata/Cargo.toml
@@ -1,15 +1,16 @@
 [package]
-name         = "esp-metadata"
-version      = "0.6.0"
-edition      = "2021"
-rust-version = "1.84.0"
-description  = "Metadata for Espressif devices"
-repository   = "https://github.com/esp-rs/esp-hal"
-license      = "MIT OR Apache-2.0"
+name          = "esp-metadata"
+version       = "0.6.0"
+edition       = "2021"
+rust-version  = "1.84.0"
+description   = "Metadata for Espressif devices"
+documentation = "https://docs.espressif.com/projects/rust/"
+repository    = "https://github.com/esp-rs/esp-hal"
+license       = "MIT OR Apache-2.0"
 
 [dependencies]
 anyhow     = "1.0.95"
 clap       = { version = "4.5.26", features = ["derive"], optional = true }
-basic-toml  = "0.1.9"
-serde       = { version = "1.0.217", features = ["derive"] }
-strum       = { version = "0.26.3",  features = ["derive"] }
+basic-toml = "0.1.9"
+serde      = { version = "1.0.217", features = ["derive"] }
+strum      = { version = "0.26.3", features = ["derive"] }
diff --git a/esp-println/Cargo.toml b/esp-println/Cargo.toml
@@ -1,32 +1,33 @@
 [package]
-name         = "esp-println"
-version      = "0.13.1"
-edition      = "2021"
-rust-version = "1.84.0"
-description  = "Provides `print!` and `println!` implementations various Espressif devices"
-keywords     = ["defmt", "embedded", "esp32", "espressif", "logging"]
-categories   = ["embedded", "hardware-support", "no-std"]
-repository   = "https://github.com/esp-rs/esp-hal"
-license      = "MIT OR Apache-2.0"
-links        = "esp-println"
+name          = "esp-println"
+version       = "0.13.1"
+edition       = "2021"
+rust-version  = "1.84.0"
+description   = "Provides `print!` and `println!` implementations various Espressif devices"
+documentation = "https://docs.espressif.com/projects/rust/"
+keywords      = ["defmt", "embedded", "esp32", "espressif", "logging"]
+categories    = ["embedded", "hardware-support", "no-std"]
+repository    = "https://github.com/esp-rs/esp-hal"
+license       = "MIT OR Apache-2.0"
+links         = "esp-println"
 
 [package.metadata.docs.rs]
 cargo-args     = ["-Z", "build-std=core"]
 default-target = "riscv32imc-unknown-none-elf"
 features       = ["esp32c3"]
 
 [dependencies]
-critical-section = { version = "1.2.0",  optional = true }
-defmt            = { version = "0.3.10",  optional = true }
+critical-section = { version = "1.2.0", optional = true }
+defmt            = { version = "0.3.10", optional = true }
 log              = { version = "0.4.26", optional = true }
-portable-atomic  = { version = "1.11.0",  optional = true, default-features = false }
+portable-atomic  = { version = "1.11.0", optional = true, default-features = false }
 
 [build-dependencies]
 esp-build = { version = "0.2.0", path = "../esp-build" }
 log       = "0.4.26"
 
 [features]
-default          = ["critical-section", "colors", "auto"]
+default          = ["auto", "colors", "critical-section"]
 critical-section = ["dep:critical-section"]
 log              = ["dep:log"]
 

diff --git a/esp-riscv-rt/Cargo.toml b/esp-riscv-rt/Cargo.toml
@@ -1,13 +1,14 @@
 [package]
-name         = "esp-riscv-rt"
-version      = "0.10.0"
-edition      = "2021"
-rust-version = "1.84.0"
-description  = "Minimal runtime / startup for RISC-V CPUs from Espressif"
-keywords     = ["esp32", "espressif", "riscv", "runtime", "startup"]
-categories   = ["embedded", "hardware-support", "no-std"]
-repository   = "https://github.com/esp-rs/esp-hal"
-license      = "MIT OR Apache-2.0"
+name          = "esp-riscv-rt"
+version       = "0.10.0"
+edition       = "2021"
+rust-version  = "1.84.0"
+description   = "Minimal runtime / startup for RISC-V CPUs from Espressif"
+documentation = "https://docs.espressif.com/projects/rust/"
+keywords      = ["esp32", "espressif", "riscv", "runtime", "startup"]
+categories    = ["embedded", "hardware-support", "no-std"]
+repository    = "https://github.com/esp-rs/esp-hal"
+license       = "MIT OR Apache-2.0"
 
 [dependencies]
 document-features = "0.2.11"
@@ -21,7 +22,4 @@ has-mie-mip = []
 rtc-ram = []
 
 # This feature is intended for testing; you probably don't want to enable it:
-ci = [
-    "has-mie-mip",
-    "rtc-ram",
-]
+ci = ["has-mie-mip", "rtc-ram"]
diff --git a/esp-storage/Cargo.toml b/esp-storage/Cargo.toml
@@ -1,41 +1,42 @@
 [package]
-name = "esp-storage"
-version = "0.5.0"
-edition = "2021"
-rust-version = "1.84.0"
-description  = "Implementation of embedded-storage traits to access unencrypted ESP32 flash"
-keywords     = ["embedded-storage", "esp32", "espressif", "no-std"]
-categories   = ["embedded", "hardware-support", "no-std"]
-repository   = "https://github.com/esp-rs/esp-storage"
-license      = "MIT OR Apache-2.0"
+name          = "esp-storage"
+version       = "0.5.0"
+edition       = "2021"
+rust-version  = "1.84.0"
+description   = "Implementation of embedded-storage traits to access unencrypted ESP32 flash"
+documentation = "https://docs.espressif.com/projects/rust/"
+keywords      = ["embedded-storage", "esp32", "espressif", "no-std"]
+categories    = ["embedded", "hardware-support", "no-std"]
+repository    = "https://github.com/esp-rs/esp-storage"
+license       = "MIT OR Apache-2.0"
 
 [package.metadata.docs.rs]
 default-target = "riscv32imac-unknown-none-elf"
 features       = ["esp32c6"]
 
 [dependencies]
 embedded-storage = "0.3.1"
-critical-section = { version =  "1.2.0", optional = true }
+critical-section = { version = "1.2.0", optional = true }
 
 [build-dependencies]
 esp-build = { version = "0.2.0", path = "../esp-build" }
 
 [features]
-default = ["critical-section", "storage"]
+default          = ["critical-section", "storage"]
 critical-section = ["dep:critical-section"]
 # ReadStorage/Storage traits
 storage = []
 # ReadNorFlash/NorFlash traits
 nor-flash = []
 # Bytewise read emulation
 bytewise-read = []
-esp32c2 = []
-esp32c3 = []
-esp32c6 = []
-esp32h2 = []
-esp32   = []
-esp32s2 = []
-esp32s3 = []
+esp32c2       = []
+esp32c3       = []
+esp32c6       = []
+esp32h2       = []
+esp32         = []
+esp32s2       = []
+esp32s3       = []
 # Enable flash emulation to run tests
 emulation = []