user0/rust
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Rollup merge of #28680 - xaviershay:doc-readme, r=steveklabnik

Browse source 
This wasn't complete (you need a `./configure`), and it is already
documented well in the main README.

r? @steveklabnik
This commit is contained in:
Steve Klabnik 2015-09-26 18:00:39 -06:00
commit cc44d65c19
1 changed files with 4 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

7
src/doc/README.md
View 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: