From 9ef7a1275fbe48da39d4de8a08a650f4784f7981 Mon Sep 17 00:00:00 2001 From: Lin Yihai Date: Sat, 11 May 2024 18:16:42 +0800 Subject: [PATCH] chore: add some link to rustdoc --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index 149f3d5ce..d273a9ce0 100644 --- a/README.md +++ b/README.md @@ -11,6 +11,12 @@ the nightly release of the Rust compiler. This readme is for developing docs.rs. See [the about page](https://docs.rs/about) for user-facing documentation. + +## How the documentation is generated + +docs.rs uses [rustdoc](https://github.com/rust-lang/rust/tree/master/src/librustdoc) to generate the documentation for every crate release on crates.io. +You can read the [the rustdoc book](https://doc.rust-lang.org/nightly/rustdoc/what-is-rustdoc.html) for more details. + ## Changing the build environment To make a change to [the build environment](https://github.com/rust-lang/crates-build-env)