diff options
| author | Joshua Nelson <jyn514@gmail.com> | 2020-12-04 12:23:46 -0500 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-12-04 18:23:46 +0100 |
| commit | 7cf284df457c5bfcc3a58b26245d073f3bf8a67a (patch) | |
| tree | a8a0b731a67c99b00dfb43a75a935f81adafa3db /src/doc/rustc-dev-guide | |
| parent | cb2ea72e78b1214ba966ec697c22a817ec530135 (diff) | |
| download | rust-7cf284df457c5bfcc3a58b26245d073f3bf8a67a.tar.gz rust-7cf284df457c5bfcc3a58b26245d073f3bf8a67a.zip | |
Link to the Rustdoc book in the rustdoc chapter (#981)
This makes a) makes it easier to find info about rustdoc's features and b) redirects people in the wrong place to where they should be looking.
Diffstat (limited to 'src/doc/rustc-dev-guide')
| -rw-r--r-- | src/doc/rustc-dev-guide/src/rustdoc.md | 2 |
1 files changed, 2 insertions, 0 deletions
diff --git a/src/doc/rustc-dev-guide/src/rustdoc.md b/src/doc/rustc-dev-guide/src/rustdoc.md index b37c15808cf..c087689d9b4 100644 --- a/src/doc/rustc-dev-guide/src/rustdoc.md +++ b/src/doc/rustc-dev-guide/src/rustdoc.md @@ -2,6 +2,8 @@ Rustdoc actually uses the rustc internals directly. It lives in-tree with the compiler and standard library. This chapter is about how it works. +For information about Rustdoc's features and how to use them, see +the [Rustdoc book](https://doc.rust-lang.org/nightly/rustdoc/). Rustdoc is implemented entirely within the crate [`librustdoc`][rd]. It runs the compiler up to the point where we have an internal representation of a |