rust - 如何将任意 Markdown 文件包含为文档属性？

<分区>

如果设置了 readme Cargo.toml 键，doc.rs 会在 crate 的索引页面上呈现 README。在本地运行 cargo doc 时，有没有办法模拟这个？

如果我添加:

#![doc = r###"contents
of
README.md
here
"###]

作为文字，我得到了我正在寻找的行为，但是内联我的整个 README.md 的副本对于进行更新来说非常不方便。

我试过:

#![doc = include!("README.md")]

但这给出了一个错误:

error: unexpected token: `include`
 --> src/lib.rs:3:10
  |
3 | #![doc = include!("README.md")]
  |          ^^^^^^^

最佳答案

有一个不稳定的功能，external-doc ，这使得这个:

示例用法(仅限夜间):

#![feature(external_doc)]

#![doc(include = "../README.md")]

关于rust - 如何将任意 Markdown 文件包含为文档属性？，我们在Stack Overflow上找到一个类似的问题： https://stackoverflow.com/questions/57421461/

相关文章：

rust - 实现迭代器的另一个特性