Docs.rs (formerly cratesfyi) is an open source project to host documentation of crates for the Rust Programming Language.
Docs.rs automatically builds crates' documentation released on crates.io using the nightly release of the Rust compiler.
The README of a crate is taken from the readme field defined in Cargo.toml. If a crate doesn't have this field, no README will be displayed.
Docs.rs is using semver to parse URLs. You can use this feature to access
crates' documentation easily. Example of URL redirections for clap crate:
| URL | Redirects to documentation of |
|---|---|
| https://docs.rs/clap | Latest version of clap |
| https://docs.rs/clap/^2 | 2.* version |
| https://docs.rs/clap/^2.9 | 2.9.* version |
| https://docs.rs/clap/2.9.3 | 2.9.3 version (you don't need = unlike semver) |
The crates.fyi domain will redirect to docs.rs, supporting all of the redirects discussed above
You can use badges to show state of your documentation to your users.
The default badge will be pointed at the latest version of a crate.
You can use version parameter to show status of documentation for
any version you want.
Badge will display in blue if docs.rs is successfully hosting your crate documentation, and red if building documentation failing.
Example badges for mio crate:
| URL | Badge |
|---|---|
| Latest version: https://docs.rs/mio/badge.svg |  |
| Version 0.4.4: https://docs.rs/mio/badge.svg?version=0.4.4 |  |
| Version 0.1.0: https://docs.rs/mio/badge.svg?version=0.1.0 |  |
Hosting generously provided by:
If you are interested in sponsoring Docs.rs, please don't hesitate to contact us at TODO.