From c04df33fba43c41548d5cc7b3fe2d746f639798e Mon Sep 17 00:00:00 2001
From: 魏曹先生 <1992414357@qq.com>
Date: Mon, 20 Jul 2026 12:54:49 +0800
Subject: feat: add docs_rs feature and improve documentation build

Add `docs_rs` feature flag to enable docs.rs-specific configuration,
including `--generate-link-to-definition` and logo display.

Include the feature in build scripts, editor settings, and feature
constants for consistent documentation generation.
---
 mingling/Cargo.toml      |  5 +++++
 mingling/src/features.rs | 11 +++++++++++
 mingling/src/lib.md      |  2 +-
 mingling/src/lib.rs      |  6 ++++--
 4 files changed, 21 insertions(+), 3 deletions(-)

(limited to 'mingling')

diff --git a/mingling/Cargo.toml b/mingling/Cargo.toml
index 2509029..351384f 100644
--- a/mingling/Cargo.toml
+++ b/mingling/Cargo.toml
@@ -21,7 +21,9 @@ mingling = { path = ".", features = [
 ] }
 
 [package.metadata.docs.rs]
+rustdoc-args = ["--generate-link-to-definition"]
 features = [
+    "docs_rs",
     "core",
     "macros",
     "builds",
@@ -87,6 +89,9 @@ ron_serde_fmt = ["mingling_core/ron_serde_fmt"]
 
 extra_macros = ["mingling_macros/extra_macros"]
 
+# Section only shown in docs.rs
+docs_rs = []
+
 [dependencies]
 mingling_core = { workspace = true, optional = true }
 mingling_macros = { workspace = true, optional = true }
diff --git a/mingling/src/features.rs b/mingling/src/features.rs
index cb474ae..78d6226 100644
--- a/mingling/src/features.rs
+++ b/mingling/src/features.rs
@@ -97,6 +97,17 @@ pub const MINGLING_DISPATCH_TREE: bool = false;
 #[cfg(feature = "dispatch_tree")]
 #[allow(unused)]
 pub const MINGLING_DISPATCH_TREE: bool = true;
+/// Whether the `docs_rs` feature is enabled
+/// Current: `disabled`
+#[cfg(not(feature = "docs_rs"))]
+#[allow(unused)]
+pub const MINGLING_DOCS_RS: bool = false;
+
+/// Whether the `docs_rs` feature is enabled
+/// Current: `enabled`
+#[cfg(feature = "docs_rs")]
+#[allow(unused)]
+pub const MINGLING_DOCS_RS: bool = true;
 /// Whether the `extra_macros` feature is enabled
 /// Current: `disabled`
 #[cfg(not(feature = "extra_macros"))]
diff --git a/mingling/src/lib.md b/mingling/src/lib.md
index 03fa61d..4d20a8b 100644
--- a/mingling/src/lib.md
+++ b/mingling/src/lib.md
@@ -76,7 +76,7 @@ Command not found: [great]
 ## Examples
 
 `Mingling` provides detailed usage examples for your reference.
-See [Examples](_mingling_examples/index.html) or [Helpdoc](https://mingling-rs.github.io/mingling/docs/examples.html)
+See [Examples](EXAMPLES/index.html) or [Helpdoc](https://mingling-rs.github.io/mingling/docs/examples.html)
 
 ## About Features
 
diff --git a/mingling/src/lib.rs b/mingling/src/lib.rs
index b6c9a5a..8f5dc38 100644
--- a/mingling/src/lib.rs
+++ b/mingling/src/lib.rs
@@ -1,3 +1,4 @@
+#![doc(html_logo_url = "https://github.com/mingling-rs/mingling/raw/main/docs/res/icon3.png")]
 #![doc = include_str!("lib.md")]
 
 #[cfg(feature = "core")]
@@ -139,8 +140,9 @@ pub use mingling_macros::Grouped;
 pub use mingling_macros::StructuralData;
 
 /// Example projects for `Mingling`, for learning how to use `Mingling`
-#[cfg(feature = "core")]
-pub mod _mingling_examples {
+#[cfg(all(feature = "core", feature = "docs_rs"))]
+#[allow(nonstandard_style)]
+pub mod EXAMPLES {
     pub use crate::example_docs::*;
 }
 
-- 
cgit