Skip to content

rust-lang/docs.rs

Repository files navigation

Docs.rs

Build Status License

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.

Redirections

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

Contributors

Sponsors

Hosting generously provided by:

Leaseweb

If you are interested in sponsoring Docs.rs, please don't hesitate to contact us at TODO.

About

crates.io documentation generator

Resources

License

Security policy

Stars

Watchers

Forks

Contributors 121