问题标签 [rustdoc]
For questions regarding programming in ECMAScript (JavaScript/JS) and its various dialects/implementations (excluding ActionScript). Note JavaScript is NOT the same as Java! Please include all relevant tags on your question; e.g., [node.js], [jquery], [json], [reactjs], [angular], [ember.js], [vue.js], [typescript], [svelte], etc.
rust - 获取特定功能或特征的 rustdoc
是否可以像在 Javadoc 工具中那样从用 Rust 编写的编程库中获取特定功能或特征的 rustdoc 片段？有什么工具可以做到这一点吗？
rust - 如何使用具有 doctest 的 Rust 项目实现条件编译？
我使用条件编译来更改函数的类型签名，现在不能为两种“功能”模式运行相同的 doctest，所以我需要一种方法来选择退出 doctest。
我已经尝试合并#[cfg_attr(feature = "rss_loose", ignore)]用于正常测试和///rust,ignore制作///rust,cfg_attr(feature = "rss_loose", ignore)，但这似乎不起作用。
rustdoc - 如何在 Rust 源代码注释文档中包含 ASCII 艺术/图表？
Markdown 应该如何与 rustdoc 一起使用以包含图表或 ASCII 艺术？
通过阅读手册，三重反引号可用于代码片段。如何包含文字、非格式化文本？
（有点像Doxygen 的 <pre>...</pre>）
command-line - 如何离线查看标准库文档？
我找到rustdoc了命令，我有点期望它像pydoc. 不幸的是，rustdoc std::io:stdin没有做我想做的事。有没有办法以离线形式查看标准库文档，无论是通过命令行还是某种内置的 Web 服务器，如 Pythonpydoc允许的那样？
documentation - 如何在文档测试中忽略一行？
如何在文档代码中写入一行但让编译器忽略它？
我想写
我想得到：
例子
要克隆某些东西，请执行
但编译器仍应编译示例（克隆 5）。
编辑：我也希望 cargo 运行示例，但省略一行。
documentation - 如何方便地托管 crate 的最新文档？
我最近在 crates.io 上发布了我的第一个 crate，我想知道是否可以以更简单的方式维护它的文档。
相当多的 crates 文档托管在 GitHub 页面上，所以我想我会试一试。我创建了一个 user.github.io 存储库，生成了文档cargo doc并将它们推送到其中。一切正常，可以从 crates.io 查看文档。
但是，更新它们很不方便；如果我修改 crate 的文档，我需要：
- 将这些更改推送到 crate 的 repo
- 通过生成更新的文档
cargo doc - 将文档的文件移动到 GitHub 页面的文件夹
- 将文档推送到文档的仓库
我很确定我做的不对——尤其是第 3 点。我能做些什么来简化这个过程？有没有更好的办法？
rust - 我可以将 Rust 文档测试的一部分外部化到外部文件吗？
在编写 Rust 文档测试时，是否可以将部分代码外部化到外部文件以保持示例简短？
rust - 有没有办法仅在 rustdoc 验证示例时启用 Cargo 功能？
我在 crate 文档中有以下内容：
问题是对stm32f103xxcrate 的依赖是可选的。如果我默认启用功能stm32f103xx，一切正常，但我不想将其设为默认。有没有办法仅在rustdoc验证示例时启用该功能？
macros - 如何在 rust 中向宏文档添加示例？
在编写宏时，我想正确地记录它，这包括示例。
但是当我尝试以与常规函数相同的方式执行此操作时，我得到：
我cargo test每晚运行以测试以下内容：
我对 doctests 的理解是每个都包含在自己的main函数中。像这样：
如果这是正确的，它将解释错误。
有什么方法可以将示例实际添加到宏中？