CINXE.COM
About Docs.rs
<!DOCTYPE html> <html lang="en"> <head> <meta charset="UTF-8"> <meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="generator" content="docs.rs 0.6.0 (ee9a3fe6 2025-03-28)"><link rel="stylesheet" href="/-/static/vendored.css?0-6-0-ee9a3fe6-2025-03-28" media="all" /> <link rel="stylesheet" href="/-/static/style.css?0-6-0-ee9a3fe6-2025-03-28" media="all" /> <link rel="stylesheet" href="/-/static/font-awesome.css?0-6-0-ee9a3fe6-2025-03-28" media="all" /> <link rel="search" href="/-/static/opensearch.xml" type="application/opensearchdescription+xml" title="Docs.rs" /> <title>About Docs.rs</title> <script nonce="Je0cubWO45QGC08p6q1bC9vcjHI9AU83OeFvdqFTve/6m4ei">(function() { function applyTheme(theme) { if (theme) { document.documentElement.dataset.docsRsTheme = theme; } } window.addEventListener("storage", ev => { if (ev.key === "rustdoc-theme") { applyTheme(ev.newValue); } }); // see ./storage-change-detection.html for details window.addEventListener("message", ev => { if (ev.data && ev.data.storage && ev.data.storage.key === "rustdoc-theme") { applyTheme(ev.data.storage.value); } }); applyTheme(window.localStorage.getItem("rustdoc-theme")); })();</script><script defer type="text/javascript" nonce="Je0cubWO45QGC08p6q1bC9vcjHI9AU83OeFvdqFTve/6m4ei" src="/-/static/menu.js?0-6-0-ee9a3fe6-2025-03-28"></script> <script defer type="text/javascript" nonce="Je0cubWO45QGC08p6q1bC9vcjHI9AU83OeFvdqFTve/6m4ei" src="/-/static/index.js?0-6-0-ee9a3fe6-2025-03-28"></script> </head> <body class="centered"> <div class="nav-container"> <div class="container"> <div class="pure-menu pure-menu-horizontal" role="navigation" aria-label="Main navigation"> <form action="/releases/search" method="GET" id="nav-search-form" class="landing-search-form-nav "> <a href="/" class="pure-menu-heading pure-menu-link docsrs-logo" aria-label="Docs.rs"> <span title="Docs.rs"><span class="fa fa-solid fa-cubes " aria-hidden="true"></span></span> <span class="title">Docs.rs</span> </a><div class="spacer"></div> <ul class="pure-menu-list"> <li class="pure-menu-item pure-menu-has-children"> <a href="#" class="pure-menu-link" aria-label="Rust">Rust</a> <ul class="pure-menu-children"> <li class="pure-menu-item"> <a class="pure-menu-link" href="/about" > About docs.rs </a> </li> <li class="pure-menu-item"> <a class="pure-menu-link" href="https://foundation.rust-lang.org/policies/privacy-policy/#docs.rs" target="_blank"> Privacy policy </a> </li> <li class="pure-menu-item"> <a class="pure-menu-link" href="https://www.rust-lang.org/" target="_blank"> Rust website </a> </li> <li class="pure-menu-item"> <a class="pure-menu-link" href="https://doc.rust-lang.org/book/" target="_blank"> The Book </a> </li> <li class="pure-menu-item"> <a class="pure-menu-link" href="https://doc.rust-lang.org/std/" target="_blank"> Standard Library API Reference </a> </li> <li class="pure-menu-item"> <a class="pure-menu-link" href="https://doc.rust-lang.org/rust-by-example/" target="_blank"> Rust by Example </a> </li> <li class="pure-menu-item"> <a class="pure-menu-link" href="https://doc.rust-lang.org/cargo/guide/" target="_blank"> The Cargo Guide </a> </li> <li class="pure-menu-item"> <a class="pure-menu-link" href="https://doc.rust-lang.org/nightly/clippy" target="_blank"> Clippy Documentation </a> </li> </ul> </li> </ul> <div id="search-input-nav"> <label for="nav-search"> <span class="fa fa-solid fa-magnifying-glass " aria-hidden="true"></span> </label> <input id="nav-search" name="query" type="text" aria-label="Find crate by search query" tabindex="-1" placeholder="Find crate" > </div> </form> </div> </div> </div> <div class="docsrs-package-container"> <div class="container"> <div class="description-container"> <h1 id="crate-title" class="no-description">Docs.rs documentation</h1> <div class="pure-menu pure-menu-horizontal"> <ul class="pure-menu-list"> <li class="pure-menu-item"> <a class="pure-menu-link pure-menu-active " href="/about"> <span class="fa fa-solid fa-circle-info " aria-hidden="true"></span> <span class='title'>About</span> </a> </li> <li class="pure-menu-item"> <a class="pure-menu-link " href="/about/badges"> <span class="fa fa-brands fa-fonticons " aria-hidden="true"></span> <span class='title'>Badges</span> </a> </li> <li class="pure-menu-item"> <a class="pure-menu-link " href="/about/builds"> <span class="fa fa-solid fa-gears " aria-hidden="true"></span> <span class='title'>Builds</span> </a> </li> <li class="pure-menu-item"> <a class="pure-menu-link " href="/about/metadata"> <span class="fa fa-solid fa-table " aria-hidden="true"></span> <span class='title'>Metadata</span> </a> </li> <li class="pure-menu-item"> <a class="pure-menu-link " href="/about/redirections"> <span class="fa fa-solid fa-road " aria-hidden="true"></span> <span class='title'>Shorthand URLs</span> </a> </li> <li class="pure-menu-item"> <a class="pure-menu-link " href="/about/download"> <span class="fa fa-solid fa-download " aria-hidden="true"></span> <span class='title'>Download</span> </a> </li> </ul> </div> </div> </div> </div> <h1 id="crate-title">About Docs.rs</h1> <div class="about-page"> <div class="container pure-u-5-6 about"> <p> Docs.rs is an <a href="https://github.com/rust-lang/docs.rs">open source</a> documentation host for crates of the <a href="https://www.rust-lang.org/">Rust Programming Language</a>. All libraries published to <a href="https://crates.io">crates.io</a> are documented. If you just published a crate, your crate is likely still in <a href="/releases/queue">the queue</a>. </p> <p> The source code of Docs.rs is available on <a href="https://github.com/rust-lang/docs.rs">GitHub</a>. If you ever encounter an issue, don't hesitate to report it! (And thanks in advance!) </p> <h2 id="more-about-docsrs"> <a href="#more-about-docsrs">More about Docs.rs</a> </h2> <ol> <li><a href="/about/badges">Badges</a>: How to use badges generated by Docs.rs</li> <li><a href="/about/builds">Builds</a>: How Docs.rs builds documentation for a crate</li> <li><a href="/about/metadata">Metadata</a>: How you can configure a build</li> <li><a href="/about/redirections">Redirections</a>: How Docs.rs uses semantic versioning in URLs</li> </ol> <h3 id="version"> <a href="#version">Version</a> </h3> <p>Currently running Docs.rs version is: <strong>0.6.0 (ee9a3fe6 2025-03-28)</strong></p> <h3 id="builds"> <a href="#builds">Builds</a> </h3> <p>Summaries of the documentation build processes <a href="/releases">are available at /releases/</a>.</p> <h3 id="javascript"> <a href="#javascript">JavaScript</a> </h3> <p> JavaScript in support of documentation is allowed but not guaranteed to work on docs.rs. What that means: If you write documentation that inlines some JavaScript (like <a href="https://katex.org/">KaTeX</a>), that's allowed, and will probably work today but may break in the future. </p> <p> However, it's not allowed to put JavaScript or other content in docs published on docs.rs for the purpose of tracking visitors. For instance, adding Google Analytics scripts, tracking pixels, or site verification for services like Google Search Console. Crates that do this will have the relevant versions removed and may be blocked from docs.rs. </p> <h3 id="contact"> <a href="#contact">Contact</a> </h3><p> Docs.rs is run and maintained by the <a href="https://www.rust-lang.org/governance/teams/dev-tools#team-docs-rs">Docs.rs team</a>. You can find us in #t-docs-rs on <a href="https://rust-lang.zulipchat.com/#narrow/stream/356853-t-docs-rs">Zulip</a>. </p> </div> </div></body> </html>