]> git.lizzy.rs Git - rust.git/commitdiff
Remove REAMDE with now-out-of-date docs about docs.
authorCorey Farwell <coreyf@rwell.org>
Tue, 18 Sep 2018 00:11:29 +0000 (20:11 -0400)
committerCorey Farwell <coreyf@rwell.org>
Tue, 18 Sep 2018 00:11:29 +0000 (20:11 -0400)
src/doc/README.md [deleted file]

diff --git a/src/doc/README.md b/src/doc/README.md
deleted file mode 100644 (file)
index 5f25894..0000000
+++ /dev/null
@@ -1,32 +0,0 @@
-# Rust documentations
-
-## Building
-
-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:
-
-~~~~text
-rustdoc --output html-doc/ --output-format html ../src/libstd/path.rs
-~~~~
-
-(This, of course, requires a working build of the `rustdoc` tool.)
-
-## Additional notes
-
-To generate an HTML version of a doc from Markdown manually, you can do
-something like:
-
-~~~~text
-rustdoc reference.md
-~~~~
-
-(`reference.md` being the Rust Reference Manual.)
-
-An overview of how to use the `rustdoc` command is available [in the docs][1].
-Further details are available from the command line by with `rustdoc --help`.
-
-[1]: https://github.com/rust-lang/rust/blob/master/src/doc/rustdoc/src/what-is-rustdoc.md