about summary refs log tree commit diff
diff options
context:
space:
mode:
authorGuillaume Gomez <guillaume1.gomez@gmail.com>2018-09-18 10:21:42 +0200
committerGitHub <noreply@github.com>2018-09-18 10:21:42 +0200
commit6a4e7bb968c0dcceb370c6654f01f745971d2478 (patch)
tree6fa9b779254641e968764b89237f0105a53be35b
parent50b9694af9739d5a4273c1928b41ee23ff59b3c7 (diff)
parentff617943e9c0f67742ab47c162210918bb2a3e1d (diff)
downloadrust-6a4e7bb968c0dcceb370c6654f01f745971d2478.tar.gz
rust-6a4e7bb968c0dcceb370c6654f01f745971d2478.zip
Rollup merge of #54311 - frewsxcv:frewsxcv-readme, r=GuillaumeGomez
Remove README with now-out-of-date docs about docs.

These docs haven't really been touched in years, and from what I tried, the `rustdoc` commands don't work. Seems like we don't need this?
-rw-r--r--src/doc/README.md32
1 files changed, 0 insertions, 32 deletions
diff --git a/src/doc/README.md b/src/doc/README.md
deleted file mode 100644
index 5f25894afd7..00000000000
--- 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