Skip to content

Commit 58c7e7f

Browse files
committed
Auto merge of #3999 - kureuil:cratesio-676, r=alexcrichton
Document new behavior of crates.io with the documentation field of the manifest [crates.io](https://crates.io/) now automatically links a crate with its [docs.rs](https://docs.rs/) page if no documentation link was specified in the manifest. See rust-lang/crates.io#676
2 parents 216db85 + ce09b86 commit 58c7e7f

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

src/doc/manifest.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,15 @@ building native code. More information can be found in the build script
4141
build = "build.rs"
4242
```
4343

44+
## The `documentation` field (optional)
45+
46+
This field specifies a URL to a website hosting the crate's documentation.
47+
If no URL is specified in the manifest file, [crates.io][cratesio] will
48+
automatically link your crate to the corresponding [docs.rs][docsrs] page.
49+
50+
[docsrs]: https://docs.rs/
51+
[cratesio]: https://crates.io/
52+
4453
## The `exclude` and `include` fields (optional)
4554

4655
You can explicitly specify to Cargo that a set of [globs][globs] should be

0 commit comments

Comments
 (0)