Skip to content

Commit b310f2f

Browse files
linyihaisyphar
authored andcommitted
chore: add some link to rustdoc
1 parent e260bd4 commit b310f2f

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,12 @@ the nightly release of the Rust compiler.
1111

1212
This readme is for developing docs.rs. See [the about page](https://docs.rs/about) for user-facing documentation.
1313

14+
15+
## How the documentation is generated
16+
17+
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.
18+
You can read the [the rustdoc book](https://doc.rust-lang.org/nightly/rustdoc/what-is-rustdoc.html) for more details.
19+
1420
## Changing the build environment
1521

1622
To make a change to [the build environment](https://github.com/rust-lang/crates-build-env)

0 commit comments

Comments
 (0)