Attempt to fix docs on docs.rs

imxrt-rs · Nov 3, 2023 · 68e6b4d · 68e6b4d
1 parent 05530d3
commit 68e6b4d
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 2 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -93,7 +93,6 @@ jobs:
       - name: Install stable toolchain
         uses: dtolnay/rust-toolchain@stable
         with:
-          components: clippy
           targets: thumbv7em-none-eabihf
 
       - name: Query crate version

diff --git a/Cargo.toml b/Cargo.toml
@@ -38,3 +38,8 @@ imxrt-log = { version = "0.1.1", default-features = false, features = [
     "lpuart",
 ] }
 log = "0.4.20"
+
+# Allow docsrs options
+[package.metadata.docs.rs]
+all-features = true
+rustdoc-args = ["--cfg", "docsrs"]
diff --git a/src/lib.rs b/src/lib.rs
@@ -1,6 +1,9 @@
-#![doc = include_str!("../README.md")]
 #![no_std]
 #![deny(unsafe_code)]
+#![deny(missing_docs)]
+#![doc = include_str!("../README.md")]
+#![doc(issue_tracker_base_url = "https://github.com/Finomnis/imxrt-uart-panic/issues")]
+#![cfg_attr(docsrs, feature(doc_cfg))]
 
 #[doc(hidden)]
 pub mod _deps {