mirror
/
rustc-dev-guide
mirror of https://github.com/rust-lang/rustc-dev-guide.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Fix a link about Rustdoc internals

This commit is contained in:
Yuki Okushi 2021-04-02 18:12:42 +09:00 committed by Joshua Nelson
parent 32c6d27b4b
commit dfe398bd5a
1 changed files with 4 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
src/rustdoc.md
View File

@ -4,9 +4,10 @@ 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/).
For more details about how rustdoc works, see the ["Rustdoc internals" chapter].
For more details about how rustdoc works, see the
["Rustdoc internals" chapter][Rustdoc internals].
["Rustdoc internals" chapter]: ./rustdoc-internals.md
[Rustdoc internals]: ./rustdoc-internals.md
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
@ -47,7 +48,7 @@ does is call the `main()` that's in this crate's `lib.rs`, though.)
bundle is meant to be used as though you would copy out the `doc` folder to
a web server, since that's where the CSS/JS and landing page are.
* Use `x.py test src/test/rustdoc*` to run the tests using a stage1 rustdoc.
* See [rustdoc internals] for more information about tests.
* See [Rustdoc internals] for more information about tests.
* Most of the HTML printing code is in `html/format.rs` and `html/render.rs`.
It's in a bunch of `fmt::Display` implementations and supplementary
functions.