From 865889a2ccf6c217df158b5e088b2fba71e86da4 Mon Sep 17 00:00:00 2001 From: Xavier Shay Date: Sat, 26 Sep 2015 12:03:42 -0700 Subject: [PATCH] Fix meta-documentation for generating all docs. This wasn't complete (you need a `./configure`), and it is already documented well in the main README. Also adds a reference to the books that this also generates. --- src/doc/README.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/src/doc/README.md b/src/doc/README.md index c09f28ae4f6..0882b073ea4 100644 --- a/src/doc/README.md +++ b/src/doc/README.md @@ -2,9 +2,10 @@ ## Building -To generate all the docs, just run `make docs` from the root of the repository. -This will convert the distributed Markdown docs to HTML and generate HTML doc -for the 'std' and 'extra' libraries. +To generate all the docs, follow the "Building Documentation" instructions in +the README in the root of the repository. This will convert the distributed +Markdown docs to HTML and generate HTML doc for the books, 'std' and 'extra' +libraries. To generate HTML documentation from one source file/crate, do something like: