使用rustdoc生成markdown文档?

9

有没有办法从 /// 注释中生成一个位于 doc/ 目录下的单个 markdown 文件?

同时生成多个 markdown 文件(例如: doc/main.md, doc/foo.md 等)也会很好。

我是 rust 的新手,虽然生成的 HTML 文档很好,但我大部分时间都在命令行上工作,不想为了查看文档而在终端和 Web 浏览器之间切换,这会中断我的工作流程并使我失去专注。此外,md 格式也很容易转换成 man 页面或者 TeX 格式的打印版或 PDF 版本。

(我习惯使用 Ctrl-Z 暂停 vim 或者使用另一个终端标签页,并运行 manperldoc 或者 pydoc 等命令。文本模式浏览器如 lynx 或者 links 对我来说不是好选择 —— 操作起来很笨拙,在我的 200+ 列终端窗口上输出不美观如果忘记使用 -width 选项,而且都不支持 JavaScript)


一年过去了,我们仍然没有一个明确的答案吗? - ANimator120
1个回答

2

cargo-readme 可能适合你。你可以运行 cargo readme -i foo.rs > FOO.md,它会将 foo.rs 中的文档注释内容填充到 FOO.md 文件中。通过Reddit发现此方法。


网页内容由stack overflow 提供, 点击上面的
可以查看英文原文,
原文链接