Add docrs attribute to generate better docs

zino-rs · Dec 31, 2023 · b970f94 · b970f94
1 parent 099f2ca
commit b970f94
Show file tree

Hide file tree

Showing 11 changed files with 17 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -23,7 +23,7 @@ which emphasizes **simplicity**, **extensibility** and **productivity**.
 ## Getting started
 
 You can start with the example [`actix-app`], [`axum-app`] or [`dioxus-desktop`].
-It requires stable **rustc 75+** to build the project.
+It requires **Rust 1.75+** to build the project.
 
 ```shell
 cd examples/axum-app

diff --git a/examples/dioxus-desktop/config/config.dev.toml b/examples/dioxus-desktop/config/config.dev.toml
@@ -8,7 +8,7 @@ uploads = "local/uploads"
 
 [window]
 title = "DataCube"
-theme = "Light"
+theme = "Dark"
 transparent = false
 
 [desktop]

diff --git a/examples/dioxus-desktop/src/view/overview.rs b/examples/dioxus-desktop/src/view/overview.rs
@@ -47,6 +47,10 @@ pub fn Overview(cx: Scope) -> Element {
                             class: "mr-2",
                             src: "https://img.shields.io/github/languages/top/photino/zino",
                         }
+                        img {
+                            class: "mr-2",
+                            src: "https://img.shields.io/badge/rustc-1.75+-blue.svg",
+                        }
                         a {
                             class: "mr-2",
                             href: "https://github.com/photino/zino/tags",

diff --git a/zino-core/Cargo.toml b/zino-core/Cargo.toml
@@ -15,6 +15,7 @@ readme = "README.md"
 [package.metadata.docs.rs]
 features = ["full", "runtime-tokio"]
 cargo-args = ["-Zunstable-options", "-Zrustdoc-scrape-examples"]
+rustdoc-args = ["--cfg", "docsrs"]
 
 [features]
 accessor = ["opendal"]

diff --git a/zino-core/src/lib.rs b/zino-core/src/lib.rs
@@ -1,3 +1,4 @@
+#![cfg_attr(docsrs, feature(doc_auto_cfg))]
 #![doc = include_str!("../README.md")]
 #![doc(html_favicon_url = "https://zino.cc/assets/zino-logo.png")]
 #![doc(html_logo_url = "https://zino.cc/assets/zino-logo.svg")]

diff --git a/zino-extra/Cargo.toml b/zino-extra/Cargo.toml
@@ -15,6 +15,7 @@ readme = "README.md"
 [package.metadata.docs.rs]
 features = ["full"]
 cargo-args = ["-Zunstable-options", "-Zrustdoc-scrape-examples"]
+rustdoc-args = ["--cfg", "docsrs"]
 
 [features]
 all-formats = ["format", "format-pdf"]

diff --git a/zino-extra/src/lib.rs b/zino-extra/src/lib.rs
@@ -1,3 +1,4 @@
+#![cfg_attr(docsrs, feature(doc_auto_cfg))]
 #![doc = include_str!("../README.md")]
 #![doc(html_favicon_url = "https://zino.cc/assets/zino-logo.png")]
 #![doc(html_logo_url = "https://zino.cc/assets/zino-logo.svg")]

diff --git a/zino-model/Cargo.toml b/zino-model/Cargo.toml
@@ -12,6 +12,10 @@ repository = "https://github.com/photino/zino"
 documentation = "https://docs.rs/zino-model"
 readme = "README.md"
 
+[package.metadata.docs.rs]
+cargo-args = ["-Zunstable-options", "-Zrustdoc-scrape-examples"]
+rustdoc-args = ["--cfg", "docsrs"]
+
 [features]
 default = [
     "namespace",

diff --git a/zino-model/src/lib.rs b/zino-model/src/lib.rs
@@ -1,3 +1,4 @@
+#![cfg_attr(docsrs, feature(doc_auto_cfg))]
 #![doc = include_str!("../README.md")]
 #![doc(html_favicon_url = "https://zino.cc/assets/zino-logo.png")]
 #![doc(html_logo_url = "https://zino.cc/assets/zino-logo.svg")]

diff --git a/zino/Cargo.toml b/zino/Cargo.toml
@@ -15,6 +15,7 @@ readme = "README.md"
 [package.metadata.docs.rs]
 features = ["axum"]
 cargo-args = ["-Zunstable-options", "-Zrustdoc-scrape-examples"]
+rustdoc-args = ["--cfg", "docsrs"]
 
 [features]
 actix = [

diff --git a/zino/src/lib.rs b/zino/src/lib.rs
@@ -1,3 +1,4 @@
+#![cfg_attr(docsrs, feature(doc_auto_cfg))]
 #![doc = include_str!("../README.md")]
 #![doc(html_favicon_url = "https://zino.cc/assets/zino-logo.png")]
 #![doc(html_logo_url = "https://zino.cc/assets/zino-logo.svg")]