Add notes about building documentation to the README.

Fixes #27632
This commit is contained in:
Steve Klabnik 2015-08-18 13:49:20 -04:00
parent c6291e04cc
commit fd53ea28d8

View file

@ -82,6 +82,28 @@ Read ["Installing Rust"] from [The Book].
$ make && make install
```
## Building Documentation
If youd like to build the documentation, its almost the same:
```sh
./configure
$ make docs
```
Building the documentation requires building the compiler, so the above
details will apply. Once you have the compiler built, you can
```sh
$ make docs NO_REBUILD=1
```
To make sure you dont re-build the compiler because you made a change
to some documentation.
The generated documentation will appear in a top-level `doc` directory,
created by the `make` rule.
## Notes
Since the Rust compiler is written in Rust, it must be built by a