diff options
| author | Guillaume Gomez <guillaume1.gomez@gmail.com> | 2018-10-13 14:42:33 +0200 |
|---|---|---|
| committer | Guillaume Gomez <guillaume1.gomez@gmail.com> | 2018-11-02 00:01:53 +0100 |
| commit | 1244a85729ec542636d2cf30f02aa31b2de2a737 (patch) | |
| tree | 82ad3abb007433ed4ebc37359d14987a300aa02c /src | |
| parent | a40b758cd8995131f1cdcddb8e1924ca0679ff1f (diff) | |
| download | rust-1244a85729ec542636d2cf30f02aa31b2de2a737.tar.gz rust-1244a85729ec542636d2cf30f02aa31b2de2a737.zip | |
Add documentation for index-page features
Diffstat (limited to 'src')
| -rw-r--r-- | src/doc/rustdoc/src/unstable-features.md | 13 |
1 files changed, 13 insertions, 0 deletions
diff --git a/src/doc/rustdoc/src/unstable-features.md b/src/doc/rustdoc/src/unstable-features.md index 071575b1fc0..71f499f44ad 100644 --- a/src/doc/rustdoc/src/unstable-features.md +++ b/src/doc/rustdoc/src/unstable-features.md @@ -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. |
