From fd53ea28d8a85ceec71bd5f4016c44eab7e58ccf Mon Sep 17 00:00:00 2001 From: Steve Klabnik Date: Tue, 18 Aug 2015 13:49:20 -0400 Subject: [PATCH] Add notes about building documentation to the README. Fixes #27632 --- README.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) 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 -- 2.44.0