Add link from docsrs to full API documentation (#2297)

microsoft · Jan 23, 2023 · 19a991e · 19a991e
1 parent ddf5ebb
commit 19a991e
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 0 deletions.
diff --git a/crates/libs/windows/Cargo.toml b/crates/libs/windows/Cargo.toml
@@ -14,6 +14,7 @@ rust-version = "1.64"
 [package.metadata.docs.rs]
 default-target = "x86_64-pc-windows-msvc"
 targets = []
+rustc-args = ["--cfg", "docsrs"]
 
 [target.'cfg(not(windows_raw_dylib))'.dependencies]
 windows-targets = { path = "../targets",  version = "0.42.1" }

diff --git a/crates/libs/windows/src/lib.rs b/crates/libs/windows/src/lib.rs
@@ -1,3 +1,5 @@
+#![cfg_attr(docsrs, doc = "This is a stub. The latest API documentation is here: <https://microsoft.github.io/windows-docs-rs/>")]
+#![cfg_attr(docsrs, doc = "")]
 /*!
 Learn more about Rust for Windows here: <https://github.com/microsoft/windows-rs>
 */

diff --git a/crates/tools/windows/src/main.rs b/crates/tools/windows/src/main.rs
@@ -55,6 +55,7 @@ rust-version = "1.64"
 [package.metadata.docs.rs]
 default-target = "x86_64-pc-windows-msvc"
 targets = []
+rustc-args = ["--cfg", "docsrs"]
 
 [target.'cfg(not(windows_raw_dylib))'.dependencies]
 windows-targets = { path = "../targets",  version = "0.42.1" }