diff options
| author | Steve Klabnik <steve@steveklabnik.com> | 2015-08-18 15:03:11 -0400 |
|---|---|---|
| committer | Steve Klabnik <steve@steveklabnik.com> | 2015-08-18 15:03:11 -0400 |
| commit | d27dc3edd4d6f01dc2b065f2a73d4ab3fab0e252 (patch) | |
| tree | ed921c7e5ccca54740d85b52597cc81d440dcdce | |
| parent | 945603c85bb3acf451de7ef1c9b2eb658644af2c (diff) | |
| parent | fd53ea28d8a85ceec71bd5f4016c44eab7e58ccf (diff) | |
| download | rust-d27dc3edd4d6f01dc2b065f2a73d4ab3fab0e252.tar.gz rust-d27dc3edd4d6f01dc2b065f2a73d4ab3fab0e252.zip | |
Rollup merge of #27884 - steveklabnik:gh27632, r=alexcrichton
Fixes #27632
| -rw-r--r-- | README.md | 22 |
1 files changed, 22 insertions, 0 deletions
diff --git a/README.md b/README.md index 0ae93380e59..391ada0efef 100644 --- a/README.md +++ b/README.md @@ -82,6 +82,28 @@ Read ["Installing Rust"] from [The Book]. $ make && make install ``` +## Building Documentation + +If you’d like to build the documentation, it’s 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 don’t 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 |
