How can I download Rust API docs?

Question

Is there a way I can download the API library docs for Rust or generate them? The only docs I can find in the Rust source are in src/docs.

I\'m running the nightly b

Answer 1

I recommend adding a link to file:///usr/local/share/doc/rust/html/index.html in your browser/desktops bookmarks.

Answer 2

If you're running Arch, install rust-docs and navigate to file:///usr/share/doc/rust/html/index.html.

Answer 3

Another way to have the Rust docs (and a few others from languages to frameworks to CLI tools) for offline use is to install Zeal for Linux or Dash for OS X and download Rust's documentation from there.

Answer 4

Rustup

If you use rustup, the recommended way to install and update Rust, then the docs may already be installed; the default installation behavior has changed over time. Try running rustup doc to open them in your browser.

If they aren't already installed, you can download the docs by running rustup component add rust-docs.

By default, rustup doc opens the documentation front page, but you can add --std to jump straight to the standard API docs or --book for The Rust Programming Language. You can also use rustup doc std::iter::Iterator to open the documentation of a specific item.

rustup 1.20 learned the concept of profiles. These allow you to default to having docs installed for a toolchain (via the default profile) or not (via the minimal profile).

Standalone Rust Installer

The Rust installer also installs the documentation for the language and for Cargo. On Linux systems, it can be found at /usr/local/share/doc/{rust,cargo}.