diff options
| author | Guillaume Gomez <guillaume1.gomez@gmail.com> | 2019-05-23 13:45:08 +0200 |
|---|---|---|
| committer | Guillaume Gomez <guillaume1.gomez@gmail.com> | 2019-11-18 16:43:47 +0100 |
| commit | 3eba28432fc83935940e0c44182eec4c97e12b69 (patch) | |
| tree | 3c27be14178362126ef1f6aba29c6406889c0754 /src/doc/rustdoc | |
| parent | add6204484706c4a28b1d7cfbfd5fc336e18c9cf (diff) | |
| download | rust-3eba28432fc83935940e0c44182eec4c97e12b69.tar.gz rust-3eba28432fc83935940e0c44182eec4c97e12b69.zip | |
Add documentation for stabilized flags
Diffstat (limited to 'src/doc/rustdoc')
| -rw-r--r-- | src/doc/rustdoc/src/command-line-arguments.md | 22 |
1 files changed, 21 insertions, 1 deletions
diff --git a/src/doc/rustdoc/src/command-line-arguments.md b/src/doc/rustdoc/src/command-line-arguments.md index b21defaedc3..9bbb396323d 100644 --- a/src/doc/rustdoc/src/command-line-arguments.md +++ b/src/doc/rustdoc/src/command-line-arguments.md @@ -355,7 +355,27 @@ $ rustdoc src/lib.rs --edition 2018 $ rustdoc --test src/lib.rs --edition 2018 ``` -This flag allows rustdoc to treat your rust code as the given edition. It will compile doctests with +This flag allows `rustdoc` to treat your rust code as the given edition. It will compile doctests with the given edition as well. As with `rustc`, the default edition that `rustdoc` will use is `2015` (the first edition). +## `themes`: add more themes to generated documentation + +By default, `rustdoc` only provides the "dark" and light" themes. If you want to add new ones, +you'll need to this flag as follows: + +```bash +$ rustdoc src/lib.rs --themes /path/to/your/theme/file.css +``` + +### `theme-checker`: check if your themes implement all the required rules + +This flag allows you to check if your themes implement the necessary CSS rules. To put it more +simply, when adding a new theme, it needs to implements all the CSS rules present in the `ðark` and +`light` CSS themes. + +You can use this flag like this: + +```bash +$ rustdoc src/lib.rs --theme-checker /path/to/your/theme/file.css +``` |
