File tree 5 files changed +9
-9
lines changed
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 @@ -334,14 +334,14 @@ $ rustdoc src/lib.rs -Z unstable-options --themes theme.css
334
334
335
335
Giving this flag to ` rustdoc ` will make it copy your theme into the generated crate docs and enable
336
336
it in the theme selector. Note that ` rustdoc ` will reject your theme file if it doesn't style
337
- everything the "light" theme does. See ` --theme-checker ` below for details.
337
+ everything the "light" theme does. See ` --check-theme ` below for details.
338
338
339
- ### ` --theme-checker ` : verify theme CSS for validity
339
+ ### ` --check-theme ` : verify theme CSS for validity
340
340
341
341
Using this flag looks like this:
342
342
343
343
``` bash
344
- $ rustdoc -Z unstable-options --theme-checker theme.css
344
+ $ rustdoc -Z unstable-options --check-theme theme.css
345
345
```
346
346
347
347
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 @@ -252,8 +252,8 @@ fn opts() -> Vec<RustcOptGroup> {
252
252
"additional themes which will be added to the generated docs" ,
253
253
"FILES" )
254
254
} ) ,
255
- stable( "theme-checker " , |o| {
256
- o. optmulti( "" , "theme-checker " ,
255
+ stable( "check-theme " , |o| {
256
+ o. optmulti( "" , "check-theme " ,
257
257
"check if given theme is valid" ,
258
258
"FILES" )
259
259
} ) ,
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