Skip to content

Commit fd53ea2

Browse files
committed
Add notes about building documentation to the README.
Fixes #27632
1 parent c6291e0 commit fd53ea2

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

README.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,28 @@ Read ["Installing Rust"] from [The Book].
8282
$ make && make install
8383
```
8484

85+
## Building Documentation
86+
87+
If you’d like to build the documentation, it’s almost the same:
88+
89+
```sh
90+
./configure
91+
$ make docs
92+
```
93+
94+
Building the documentation requires building the compiler, so the above
95+
details will apply. Once you have the compiler built, you can
96+
97+
```sh
98+
$ make docs NO_REBUILD=1
99+
```
100+
101+
To make sure you don’t re-build the compiler because you made a change
102+
to some documentation.
103+
104+
The generated documentation will appear in a top-level `doc` directory,
105+
created by the `make` rule.
106+
85107
## Notes
86108

87109
Since the Rust compiler is written in Rust, it must be built by a

0 commit comments

Comments
 (0)