Skip to content

Commit

Permalink
Rollup merge of rust-lang#28680 - xaviershay:doc-readme, r=steveklabnik
Browse files Browse the repository at this point in the history
This wasn't complete (you need a `./configure`), and it is already
documented well in the main README.

r? @steveklabnik
  • Loading branch information
steveklabnik committed Sep 27, 2015
2 parents 3e36eec + 865889a commit cc44d65
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions src/doc/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down

0 comments on commit cc44d65

Please sign in to comment.