sdk: add doctest module

rust-nostr · Jan 15, 2023 · 446f1f0 · 446f1f0
1 parent d9ea5ca
commit 446f1f0
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 2 deletions.
diff --git a/crates/nostr-sdk/src/doctest.rs b/crates/nostr-sdk/src/doctest.rs
@@ -0,0 +1,6 @@
+// Copyright (c) 2022-2023 Yuki Kishimoto
+// Distributed under the MIT software license
+
+#[doc = include_str!("../README.md")]
+#[cfg(doctest)]
+pub struct ReadmeDoctests;
diff --git a/crates/nostr-sdk/src/lib.rs b/crates/nostr-sdk/src/lib.rs
@@ -1,8 +1,6 @@
 // Copyright (c) 2022-2023 Yuki Kishimoto
 // Distributed under the MIT software license
 
-#![doc = include_str!("../README.md")]
-
 #[cfg(feature = "blocking")]
 use once_cell::sync::Lazy;
 #[cfg(feature = "blocking")]
@@ -12,6 +10,8 @@ pub use nostr;
 pub use nostr::Result;
 
 pub mod client;
+#[cfg(feature = "all-nips")]
+mod doctest;
 pub mod relay;
 pub mod subscription;
 mod thread;