rust - 如何包含任意降价文件作为文档属性？

Question

如果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")]
  |          ^^^^^^^

score 5 · Accepted Answer

有一个不稳定的功能，external-doc可以实现这一点：

示例用法（仅每晚）：

#![feature(external_doc)]

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

1 回答 1