如何下载Rust API文档?

时间:2014-12-21 17:46:58

标签: rust

有没有办法可以下载Rust的API库文档或生成它们?我可以在Rust源中找到的唯一文档位于src/docs

我正在运行每晚构建,因此我确信有一种方法可以使用rustdoc以与standard docs相同的方式生成所有文档,我找不到它!

我正在运行Linux,使用此命令进行每晚构建:

curl -s https://static.rust-lang.org/rustup.sh | sudo sh

4 个答案:

答案 0 :(得分:67)

<强> Rustup

如果您使用rustup recommended way to install and update Rust,则可能已经安装了文档;默认安装行为随时间而变化。尝试运行rustup doc以在浏览器中打开它们。

如果尚未安装,则可以通过运行rustup component add rust-docs

来下载文档

默认情况下,rustup doc会打开文档首页,但您可以添加--std直接跳转到标准API文档或--book The Rust Programming Language

独立防锈安装程序

Rust安装程序还会安装该语言和Cargo的文档。在Linux系统上,可以在/usr/local/share/doc/{rust,cargo}找到它。

答案 1 :(得分:7)

另一种将Rust文档(以及其他一些从语言到框架再到CLI工具)供脱机使用的方法是为Linux安装Zeal或为OS X安装Dash并下载Rust&#39那里的文件。

答案 2 :(得分:3)

如果您正在运行Arch,请安装rust-docs并导航至file:///usr/share/doc/rust/html/index.html

答案 3 :(得分:2)

我建议在浏览器/桌面书签中添加指向file:///usr/local/share/doc/rust/html/index.html的链接。