From ff617943e9c0f67742ab47c162210918bb2a3e1d Mon Sep 17 00:00:00 2001 From: Corey Farwell Date: Mon, 17 Sep 2018 20:11:29 -0400 Subject: [PATCH] Remove REAMDE with now-out-of-date docs about docs. --- src/doc/README.md | 32 -------------------------------- 1 file changed, 32 deletions(-) delete mode 100644 src/doc/README.md diff --git a/src/doc/README.md b/src/doc/README.md deleted file mode 100644 index 5f25894afd76d..0000000000000 --- a/src/doc/README.md +++ /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