Skip to content

Commit 865889a

Browse files
committed
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.
1 parent 9169e6c commit 865889a

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

src/doc/README.md

+4-3
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,10 @@
22

33
## Building
44

5-
To generate all the docs, just run `make docs` from the root of the repository.
6-
This will convert the distributed Markdown docs to HTML and generate HTML doc
7-
for the 'std' and 'extra' libraries.
5+
To generate all the docs, follow the "Building Documentation" instructions in
6+
the README in the root of the repository. This will convert the distributed
7+
Markdown docs to HTML and generate HTML doc for the books, 'std' and 'extra'
8+
libraries.
89

910
To generate HTML documentation from one source file/crate, do something like:
1011

0 commit comments

Comments
 (0)