Merge pull request #246 from H1rono/doc_cfg

H1rono · web-flow · commit 8bbdf9b84ea6 · 2024-12-09T01:08:43.000+09:00
🔧 Configure `doc_cfg` for docs.rs
diff --git a/.cspell-dict/lib-words.txt b/.cspell-dict/lib-words.txt
@@ -6,6 +6,7 @@ chrono
 eprintln
 serde
 combinators
+docsrs
 
 HTAB
 VCHAR
diff --git a/.cspell-dict/tool-words.txt b/.cspell-dict/tool-words.txt
@@ -1,6 +1,7 @@
 rustup
 rustc
 rustfmt
+rustdoc
 clippy
 MSRV
 RUSTFLAGS
diff --git a/Cargo.toml b/Cargo.toml
@@ -20,6 +20,7 @@ include = ["/src", "/examples", "/README.md", "/LICENSE"]
 
 [package.metadata.docs.rs]
 features = ["tower"]
+rustdoc-args = ["--cfg", "docsrs"]
 
 [dependencies]
 serde = { version = "1.0", features = ["derive"] }
diff --git a/src/lib.rs b/src/lib.rs
@@ -1,3 +1,5 @@
+#![cfg_attr(docsrs, feature(doc_auto_cfg, doc_cfg))]
+
 //! [![GitHub](https://img.shields.io/github/license/H1rono/traq-bot-http-rs?style=for-the-badge&logo=github)](https://github.com/H1rono/traq-bot-http-rs/blob/main/LICENSE)
 //! [![Crates.io](https://img.shields.io/crates/l/traq-bot-http?style=for-the-badge&logo=docsdotrs)](https://crates.io/crates/traq-bot-http)
 //! [![GitHub release](https://img.shields.io/github/v/release/H1rono/traq-bot-http-rs?style=for-the-badge&logo=github)](https://github.com/H1rono/traq-bot-http-rs/releases/latest)

-Original file line number
+Diff line change
 rustup
 rustc
 rustfmt
 +rustdoc
 clippy
 MSRV
 RUSTFLAGS
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+#![cfg_attr(docsrs, feature(doc_auto_cfg, doc_cfg))]`
	`2`	`+`
`1`	`3`	`//! [![GitHub](https://img.shields.io/github/license/H1rono/traq-bot-http-rs?style=for-the-badge&logo=github)](https://github.com/H1rono/traq-bot-http-rs/blob/main/LICENSE)`
`2`	`4`	`//! [![Crates.io](https://img.shields.io/crates/l/traq-bot-http?style=for-the-badge&logo=docsdotrs)](https://crates.io/crates/traq-bot-http)`
`3`	`5`	`//! [![GitHub release](https://img.shields.io/github/v/release/H1rono/traq-bot-http-rs?style=for-the-badge&logo=github)](https://github.com/H1rono/traq-bot-http-rs/releases/latest)`