dep_doc

在您的crate文档中添加一个可爱的依赖声明片段。

添加到 Cargo.toml

[dependencies]
dep_doc = "0.1.1"

目标

在编写Rust库时，通常需要在文档中添加一个代码片段，向最终用户展示如何将crate添加到Cargo.toml。问题是，在发布新版本之前，没有方法确保crate名称和版本的正确性。

此crate旨在通过提供宏辅助解决方案来自动化TOML片段的生成，该解决方案可以扩展为正确的crate名称和版本。它通过读取由cargo设置的环境变量来实现。

使用方法

要添加TOML片段，在两个文档行之间插入以下行

//! Some doc...
#![doc = dep_doc::dep_doc!()]
//! Some other doc

如果调用dep_doc，这将生成以下文档

一些文档...

[dependencies]
dep_doc = "0.1.1"

其他文档

自定义

某些crate可能需要记录特定功能、git仓库、分支、提交哈希等。这可以通过在dep_doc调用中传递代码来实现

//! Some doc...
#![doc = dep_doc::dep_doc!(git = "https://github.com/scrabsha/dep-doc")]
//! Some other doc

如果调用dep_doc，这将生成以下文档

一些文档...

[dependencies]
dep_doc = { version = "0.1.1", git = "https://github.com/scrabsha/dep-doc" }

其他文档

我的库更适合作为开发依赖项

没关系！ dev_dep_doc将替换[dependencies]部分为[dev-dependencies]部分。

//! Some doc...
#![doc = dep_doc::dev_dep_doc!(features = ["proc_macro", "no_std"])]
//! Some other doc

如果调用dep_doc，这将生成以下文档

一些文档...

[dev-dependencies]
dep_doc = { version = "0.1.1", features = ["prod_macro", "no_std"] }

其他文档

许可