Merge pull request #12 from p2pderivatives/chore/rust-bitcoin-prep-ad…

…d-cfg-docsrs Add rustdoc build to CI script
p2pderivatives · Dec 23, 2022 · 3a04149 · 3a04149
2 parents 8890410 + 72af05a
commit 3a04149
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 0 deletions.
diff --git a/contrib/test.sh b/contrib/test.sh
@@ -30,3 +30,8 @@ if [ "$DO_LINT" = true ]
 then
     cargo clippy --all-features --all-targets -- -D warnings
 fi
+
+# Build the docs if told to (this only works with the nightly toolchain)
+if [ "$DO_DOCS" = true ]; then
+    RUSTDOCFLAGS="--cfg docsrs" cargo +nightly rustdoc --all-features -- -D rustdoc::broken-intra-doc-links -D warnings || exit 1
+fi
diff --git a/src/lib.rs b/src/lib.rs
@@ -10,6 +10,9 @@
 #![deny(unused_mut)]
 #![deny(missing_docs)]
 
+// Experimental features we need.
+#![cfg_attr(docsrs, feature(doc_cfg))]
+
 use std::cmp::Reverse;
 
 #[cfg(any(test, feature = "rand"))]