From 55c7be5d83d68ca2ae82dd29d3efa2f748e7ea55 Mon Sep 17 00:00:00 2001 From: Joshua Nelson Date: Fri, 4 Dec 2020 12:23:46 -0500 Subject: [PATCH] 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. --- src/rustdoc.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/src/rustdoc.md b/src/rustdoc.md index b37c1580..c087689d 100644 --- a/src/rustdoc.md +++ b/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