]> git.lizzy.rs Git - rust.git/commitdiff
Fix meta-documentation for generating all docs.
authorXavier Shay <xavier@rhnh.net>
Sat, 26 Sep 2015 19:03:42 +0000 (12:03 -0700)
committerXavier Shay <xavier@rhnh.net>
Sat, 26 Sep 2015 19:05:47 +0000 (12:05 -0700)
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

index c09f28ae4f62d5cc0dd594505f39d0e50bec19ca..0882b073ea48c32109697ec28b4d65ffae767c4a 100644 (file)
@@ -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: