diff --git a/README.md b/README.md index a5495b3..7c939ea 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ Vorago VA108xx Rust Support ========= -This crate collection provided support to write Rust applications for the VA108XX family +This crate collection provides support to write Rust applications for the VA108XX family of devices. ## List of crates diff --git a/va108xx-hal/Cargo.toml b/va108xx-hal/Cargo.toml index 50b21b8..f632158 100644 --- a/va108xx-hal/Cargo.toml +++ b/va108xx-hal/Cargo.toml @@ -43,3 +43,7 @@ default-features = false [features] default = ["rt"] rt = ["va108xx/rt"] + +[package.metadata.docs.rs] +all-features = true +rustdoc-args = ["--cfg", "docs_rs", "--generate-link-to-definition"] diff --git a/va108xx-hal/src/lib.rs b/va108xx-hal/src/lib.rs index f74b8ee..f2dea5c 100644 --- a/va108xx-hal/src/lib.rs +++ b/va108xx-hal/src/lib.rs @@ -1,4 +1,5 @@ #![no_std] +#![cfg_attr(docs_rs, feature(doc_auto_cfg))] pub use va108xx; pub use va108xx as pac; diff --git a/va108xx/Cargo.toml b/va108xx/Cargo.toml index fbd2d35..ebbfe07 100644 --- a/va108xx/Cargo.toml +++ b/va108xx/Cargo.toml @@ -21,3 +21,7 @@ version = ">=0.6.15,<0.8" [features] rt = ["cortex-m-rt/device"] + +[package.metadata.docs.rs] +all-features = true +rustdoc-args = ["--cfg", "docs_rs", "--generate-link-to-definition"] diff --git a/va108xx/src/lib.rs b/va108xx/src/lib.rs index 15bab0c..a9cf94a 100644 --- a/va108xx/src/lib.rs +++ b/va108xx/src/lib.rs @@ -3,6 +3,7 @@ svd2rust release can be generated by cloning the svd2rust [repository], checking #![allow(non_camel_case_types)] #![allow(non_snake_case)] #![no_std] +#![cfg_attr(docs_rs, feature(doc_auto_cfg))] use core::marker::PhantomData; use core::ops::Deref; #[doc = r"Number available in the NVIC for configuring priority"] diff --git a/vorago-reb1/Cargo.toml b/vorago-reb1/Cargo.toml index f046493..2ab42ae 100644 --- a/vorago-reb1/Cargo.toml +++ b/vorago-reb1/Cargo.toml @@ -18,8 +18,6 @@ dummy-pin = "1" [dependencies.max116xx-10bit] version = "0.3" -git = "https://egit.irs.uni-stuttgart.de/rust/max116xx-10bit" -branch = "bump-embedded-hal" [dependencies.va108xx-hal] version = "0.6" @@ -39,3 +37,7 @@ version = "0.5" [dev-dependencies.panic-rtt-target] version = "0.1" + +[package.metadata.docs.rs] +all-features = true +rustdoc-args = ["--cfg", "docs_rs", "--generate-link-to-definition"] diff --git a/vorago-reb1/src/lib.rs b/vorago-reb1/src/lib.rs index e2fd4e2..e51be97 100644 --- a/vorago-reb1/src/lib.rs +++ b/vorago-reb1/src/lib.rs @@ -1,4 +1,5 @@ #![no_std] +#![cfg_attr(docs_rs, feature(doc_auto_cfg))] pub mod button; pub mod leds;