src/doc/README.md

   1 # Rust documentations
   2
   3 ## Building
   4
   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.
   8
   9 To generate HTML documentation from one source file/crate, do something like:
  10
  11 ~~~~
  12 rustdoc --output html-doc/ --output-format html ../src/libstd/path.rs
  13 ~~~~
  14
  15 (This, of course, requires a working build of the `rustdoc` tool.)
  16
  17 ## Additional notes
  18
  19 To generate an HTML version of a doc from Markdown manually, you can do
  20 something like:
  21
  22 ~~~~
  23 rustdoc reference.md
  24 ~~~~
  25
  26 (`reference.md` being the Rust Reference Manual.)
  27
  28 An overview of how to use the `rustdoc` command is available [in the docs][1].
  29 Further details are available from the command line by with `rustdoc --help`.
  30
  31 [1]: https://github.com/rust-lang/rust/blob/master/src/doc/trpl/documentation.md