【问题标题】:How can I download Rust API docs?如何下载 Rust API 文档?
【发布时间】:2015-02-19 22:10:42
【问题描述】:

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

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

我正在运行 Linux,使用夜间构建,使用以下命令:

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

【问题讨论】:

    标签: rust


    【解决方案1】:

    生锈

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

    如果尚未安装,您可以通过运行rustup component add rust-docs 下载文档。

    默认情况下,rustup doc 打开文档首页,但您可以添加 --std 以直接跳转到标准 API 文档或添加 --book 以获取 Rust 编程语言。您也可以使用rustup doc std::iter::Iterator 打开特定项目的文档。

    rustup 1.20 学习了 profiles 的概念。这些允许您默认为工具链安装文档(通过default 配置文件)或不安装(通过minimal 配置文件)。

    独立 Rust 安装程序

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

    【讨论】:

    • 惊人的答案! rustup 确实是拥有的工具
    • Rustteam 摇滚!令人惊讶的是,尽管 Rust 语言/工具集还很年轻,但它的周到程度却是惊人的
    • 请注意,上述内容目前不适用于 M1 mac。 github.com/rust-lang/rustup/issues/2692
    【解决方案2】:

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

    【讨论】:

      【解决方案3】:

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

      【讨论】:

        【解决方案4】:

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

        【讨论】:

        • 这不适用于大多数使用推荐的 rustup 方法安装 Rust 的人。
        猜你喜欢
        • 1970-01-01
        • 1970-01-01
        • 1970-01-01
        • 2011-08-05
        • 2019-07-25
        • 1970-01-01
        • 1970-01-01
        • 2014-08-15
        • 2017-05-09
        相关资源
        最近更新 更多