]> git.lizzy.rs Git - rust.git/commitdiff
Add documentation for index-page features
authorGuillaume Gomez <guillaume1.gomez@gmail.com>
Sat, 13 Oct 2018 12:42:33 +0000 (14:42 +0200)
committerGuillaume Gomez <guillaume1.gomez@gmail.com>
Thu, 1 Nov 2018 23:01:53 +0000 (00:01 +0100)
src/doc/rustdoc/src/unstable-features.md

index 071575b1fc094e7c48de83422ed53e7c6497e165..71f499f44adbcdc06b55bcb1ca97018a99fab0ee 100644 (file)
@@ -389,3 +389,16 @@ pub struct BigX;
 
 Then, when looking for it through the `rustdoc` search, if you enter "x" or
 "big", search will show the `BigX` struct first.
+
+### `--index-page`: provide a top-level landing page for docs
+
+This feature allows you to generate an index-page with a given markdown file. A good example of it
+is the [rust documentation index](https://doc.rust-lang.org/index.html).
+
+With this, you'll have a page which you can custom as much as you want at the top of your crates.
+
+Using `index-page` option enables `enable-index-page` option as well.
+
+### `--enable-index-page`: generate a default index page for docs
+
+This feature allows the generation of a default index-page which lists the generated crates.