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
|URL||Redirects to documentation of|
|https://docs.rs/clap||Latest version of clap|
|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
|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|
We strongly recommend using vagrant, this will give you a virtual machine already configured and ready to start developing on.
Make sure you have vagrant, virtualbox and a ssh client and you need to able to download ~800MB data on the first run.
git clone https://github.com/rust-lang/docs.rs.git docs.rs cd docs.rs vagrant up # This may take a little while on the first run
You can always run
vagrant provision to reconfigure virtual machine.
Provision will install required dependencies and nightly rust compiler
into virtual machine. It will also configure lxc-container inside
Make sure you are running every listed command inside
in virtual machine. You can connect to virtual machine with
vagrant ssh and
switch current working directory with:
cd /vagrant inside virtual machine.
Starting web server
This command will start web interface of docs.rs and you can access it from:
cargo run -- start-web-server
# Builds <CRATE_NAME> <CRATE_VERSION> and adds it into database # This is the main command to build and add a documentation into docs.rs. cargo run -- build crate <CRATE_NAME> <CRATE_VERSION> # Adds essential files (css and fonts) into database to avoid duplication # This command needs to be run after each rustc update cargo run -- build add-essential-files # Builds every crate and adds them into database # (beware: this may take months to finish) cargo run -- build world
# Migrate database to recent version cargo run -- database migrate # Adds a directory into database to serve with `staticfile` crate. cargo run -- database add-directory <DIRECTORY> [PREFIX] # Updates github stats for crates. # You need to set CRATESFYI_GITHUB_USERNAME, CRATESFYI_GITHUB_ACCESSTOKEN # environment variables in order to run this command. # You can set this environment variables in ~/.cratesfyi.env file. cargo run -- database update-github-fields # Updates search-index. # daemon is running this command occasionally, and this command must be # run to update recent-version of a crate index and search index. # If you are having any trouble with accessing right version of a crate, # run this command. Otherwise it's not required. cargo run -- database update-search-index # Updates release activitiy chart cargo run -- database update-release-activity
If you want to explore or edit database manually, you can connect database
This subcommand will only build documentation of a crate. It is designed to run inside a secure container.
cargo run -- doc <CRATE_NAME>