$ rustdoc src/lib.rs --themes /path/to/your/theme/file.css
```
-### `theme-checker`: check if your themes implement all the required rules
+### `check-theme`: 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 "light"
You can use this flag like this:
```bash
-$ rustdoc src/lib.rs --theme-checker /path/to/your/theme/file.css
+$ rustdoc src/lib.rs --check-theme /path/to/your/theme/file.css
```
Giving this flag to `rustdoc` will make it copy your theme into the generated crate docs and enable
it in the theme selector. Note that `rustdoc` will reject your theme file if it doesn't style
-everything the "light" theme does. See `--theme-checker` below for details.
+everything the "light" theme does. See `--check-theme` below for details.
-### `--theme-checker`: verify theme CSS for validity
+### `--check-theme`: verify theme CSS for validity
Using this flag looks like this:
```bash
-$ rustdoc -Z unstable-options --theme-checker theme.css
+$ rustdoc -Z unstable-options --check-theme theme.css
```
Before including your theme in crate docs, `rustdoc` will compare all the CSS rules it contains
/// The built-in themes given to every documentation site.
pub mod themes {
/// The "light" theme, selected by default when no setting is available. Used as the basis for
- /// the `--theme-checker` functionality.
+ /// the `--check-theme` functionality.
pub static LIGHT: &'static str = include_str!("static/themes/light.css");
/// The "dark" theme.
"additional themes which will be added to the generated docs",
"FILES")
}),
- stable("theme-checker", |o| {
- o.optmulti("", "theme-checker",
+ stable("check-theme", |o| {
+ o.optmulti("", "check-theme",
"check if given theme is valid",
"FILES")
}),
exit(1);
}
let status = Command::new(rustdoc_bin)
- .args(&["-Z", "unstable-options", "--theme-checker"])
+ .args(&["-Z", "unstable-options", "--check-theme"])
.args(&themes)
.status()
.expect("failed to execute child");