如何下载 Rust API 文档？

Question

63

有没有一种方法可以下载 Rust 的 API 库文档或者生成这些文档？我在 Rust 源代码中只能找到在 src/docs 中的文档。

我正在使用夜版构建，所以我确定有一种方式可以像使用标准文档时使用 rustdoc 来生成所有文档，但我找不到它！

我正在 Linux 上运行夜版构建，使用以下命令：

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

- jonalmeida

4个回答

8

另一种将 Rust 文档（以及其他语言、框架和 CLI 工具的文档）离线使用的方法是在 Linux 上安装 Zeal 或在 OS X 上安装 Dash，然后从该软件中下载 Rust 的文档。

- sargas

5

如果你正在使用Arch系统，安装rust-docs，然后导航到file:///usr/share/doc/rust/html/index.html。

- emersion

2

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

- 6ft Dan

这对于大多数使用rustup推荐方法安装Rust的人来说是行不通的。 - poolie

网页内容由stack overflow 提供, 点击上面的

可以查看英文原文，
原文链接

- Shepmaster · Accepted Answer

Rustup

Rustup 是安装和更新 Rust 的推荐方式。如果你使用 rustup，那么文档可能已经被安装了；默认的安装行为随时间而变化。尝试运行 rustup doc 在浏览器中打开它们。

如果它们没有被安装, 你可以通过运行 rustup component add rust-docs 来下载文档。

rustup doc 默认打开文档首页，但你可以添加 --std 直接跳转到标准 API 文档或 --book 访问 The Rust Programming Language。你也可以使用 rustup doc std::iter::Iterator 打开指定项的文档。

rustup 1.20 学会了 profiles 的概念。这样可以通过 default 配置文件使工具链默认安装文档，或通过 minimal 配置文件选择不安装文档。

独立的 Rust 安装程序

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