Skip to content

Commit c431f8c

Browse files
camelidJoshua Nelson
authored and
Joshua Nelson
committed
Cleanup rustdoc chapters a bit
* Rename "The walking tour of rustdoc" to "Rustdoc overview", which I think is a more accurate name * Use same name in sidebar TOC as in chapter text * Make links between the two chapters prominent * Convert a few `.html` links to `.md` Probably we should just merge the chapters, but leaving that for later.
1 parent 3cdb245 commit c431f8c

File tree

3 files changed

+9
-12
lines changed

3 files changed

+9
-12
lines changed

src/SUMMARY.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
- [Suggested Workflows](./building/suggested.md)
1414
- [Distribution artifacts](./building/build-install-distribution-artifacts.md)
1515
- [Documenting Compiler](./building/compiler-documenting.md)
16-
- [Rustdoc](./rustdoc.md)
16+
- [Rustdoc overview](./rustdoc.md)
1717
- [ctags](./building/ctags.md)
1818
- [Adding a new target](./building/new-target.md)
1919
- [The compiler testing framework](./tests/intro.md)
@@ -63,7 +63,7 @@
6363
- [Memory Management in Rustc](./memory.md)
6464
- [Serialization in Rustc](./serialization.md)
6565
- [Parallel Compilation](./parallel-rustc.md)
66-
- [Rustdoc](./rustdoc-internals.md)
66+
- [Rustdoc internals](./rustdoc-internals.md)
6767

6868
# Source Code Representation
6969

src/rustdoc-internals.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<!-- toc -->
44

55
This page describes rustdoc's passes and modes. For an overview of rustdoc,
6-
see [`rustdoc`](./rustdoc.md).
6+
see the ["Rustdoc overview" chapter](./rustdoc.md).
77

88
## From crate to clean
99

src/rustdoc.md

+6-9
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,20 @@
1-
# The walking tour of rustdoc
1+
# Rustdoc overview
22

33
Rustdoc actually uses the rustc internals directly. It lives in-tree with the
44
compiler and standard library. This chapter is about how it works.
55
For information about Rustdoc's features and how to use them, see
66
the [Rustdoc book](https://doc.rust-lang.org/nightly/rustdoc/).
7+
For more details about how rustdoc works, see the ["Rustdoc internals" chapter].
8+
9+
["Rustdoc internals" chapter]: ./rustdoc-internals.md
710

811
Rustdoc is implemented entirely within the crate [`librustdoc`][rd]. It runs
912
the compiler up to the point where we have an internal representation of a
1013
crate (HIR) and the ability to run some queries about the types of items. [HIR]
1114
and [queries] are discussed in the linked chapters.
1215

13-
[HIR]: ./hir.html
14-
[queries]: ./query.html
16+
[HIR]: ./hir.md
17+
[queries]: ./query.md
1518
[rd]: https://github.com/rust-lang/rust/tree/master/src/librustdoc
1619

1720
`librustdoc` performs two major steps after that to render a set of
@@ -59,9 +62,3 @@ does is call the `main()` that's in this crate's `lib.rs`, though.)
5962
* Tests on search index generation are located in `src/test/rustdoc-js`, as a
6063
series of JavaScript files that encode queries on the standard library search
6164
index and expected results.
62-
63-
## See also
64-
65-
For more details about how rustdoc works, see the page on [rustdoc internals].
66-
67-
[rustdoc internals]: ./rustdoc-internals.md

0 commit comments

Comments
 (0)