File tree Expand file tree Collapse file tree 5 files changed +9
-9
lines changed Expand file tree Collapse file tree 5 files changed +9
-9
lines changed Original file line number Diff line number Diff line change @@ -368,7 +368,7 @@ you'll need to this flag as follows:
368
368
$ rustdoc src/lib.rs --themes /path/to/your/theme/file.css
369
369
```
370
370
371
- ### ` theme-checker ` : check if your themes implement all the required rules
371
+ ### ` check-theme ` : check if your themes implement all the required rules
372
372
373
373
This flag allows you to check if your themes implement the necessary CSS rules. To put it more
374
374
simply, when adding a new theme, it needs to implements all the CSS rules present in the "light"
@@ -377,5 +377,5 @@ CSS theme.
377
377
You can use this flag like this:
378
378
379
379
``` bash
380
- $ rustdoc src/lib.rs --theme-checker /path/to/your/theme/file.css
380
+ $ rustdoc src/lib.rs --check-theme /path/to/your/theme/file.css
381
381
```
Original file line number Diff line number Diff line change @@ -304,14 +304,14 @@ $ rustdoc src/lib.rs -Z unstable-options --themes theme.css
304
304
305
305
Giving this flag to ` rustdoc ` will make it copy your theme into the generated crate docs and enable
306
306
it in the theme selector. Note that ` rustdoc ` will reject your theme file if it doesn't style
307
- everything the "light" theme does. See ` --theme-checker ` below for details.
307
+ everything the "light" theme does. See ` --check-theme ` below for details.
308
308
309
- ### ` --theme-checker ` : verify theme CSS for validity
309
+ ### ` --check-theme ` : verify theme CSS for validity
310
310
311
311
Using this flag looks like this:
312
312
313
313
``` bash
314
- $ rustdoc -Z unstable-options --theme-checker theme.css
314
+ $ rustdoc -Z unstable-options --check-theme theme.css
315
315
```
316
316
317
317
Before including your theme in crate docs, ` rustdoc ` will compare all the CSS rules it contains
Original file line number Diff line number Diff line change @@ -59,7 +59,7 @@ pub static RUST_FAVICON: &'static [u8] = include_bytes!("static/favicon.ico");
59
59
/// The built-in themes given to every documentation site.
60
60
pub mod themes {
61
61
/// The "light" theme, selected by default when no setting is available. Used as the basis for
62
- /// the `--theme-checker ` functionality.
62
+ /// the `--check-theme ` functionality.
63
63
pub static LIGHT : & ' static str = include_str ! ( "static/themes/light.css" ) ;
64
64
65
65
/// The "dark" theme.
Original file line number Diff line number Diff line change @@ -256,8 +256,8 @@ fn opts() -> Vec<RustcOptGroup> {
256
256
"additional themes which will be added to the generated docs" ,
257
257
"FILES" )
258
258
} ) ,
259
- stable( "theme-checker " , |o| {
260
- o. optmulti( "" , "theme-checker " ,
259
+ stable( "check-theme " , |o| {
260
+ o. optmulti( "" , "check-theme " ,
261
261
"check if given theme is valid" ,
262
262
"FILES" )
263
263
} ) ,
Original file line number Diff line number Diff line change @@ -39,7 +39,7 @@ fn main() {
39
39
exit ( 1 ) ;
40
40
}
41
41
let status = Command :: new ( rustdoc_bin)
42
- . args ( & [ "-Z" , "unstable-options" , "--theme-checker " ] )
42
+ . args ( & [ "-Z" , "unstable-options" , "--check-theme " ] )
43
43
. args ( & themes)
44
44
. status ( )
45
45
. expect ( "failed to execute child" ) ;
You can’t perform that action at this time.
0 commit comments