Skip to content

Commit 3eba284

Browse files
Add documentation for stabilized flags
1 parent add6204 commit 3eba284

File tree

1 file changed

+21
-1
lines changed

1 file changed

+21
-1
lines changed

src/doc/rustdoc/src/command-line-arguments.md

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -355,7 +355,27 @@ $ rustdoc src/lib.rs --edition 2018
355355
$ rustdoc --test src/lib.rs --edition 2018
356356
```
357357

358-
This flag allows rustdoc to treat your rust code as the given edition. It will compile doctests with
358+
This flag allows `rustdoc` to treat your rust code as the given edition. It will compile doctests with
359359
the given edition as well. As with `rustc`, the default edition that `rustdoc` will use is `2015`
360360
(the first edition).
361361

362+
## `themes`: add more themes to generated documentation
363+
364+
By default, `rustdoc` only provides the "dark" and light" themes. If you want to add new ones,
365+
you'll need to this flag as follows:
366+
367+
```bash
368+
$ rustdoc src/lib.rs --themes /path/to/your/theme/file.css
369+
```
370+
371+
### `theme-checker`: check if your themes implement all the required rules
372+
373+
This flag allows you to check if your themes implement the necessary CSS rules. To put it more
374+
simply, when adding a new theme, it needs to implements all the CSS rules present in the `ðark` and
375+
`light` CSS themes.
376+
377+
You can use this flag like this:
378+
379+
```bash
380+
$ rustdoc src/lib.rs --theme-checker /path/to/your/theme/file.css
381+
```

0 commit comments

Comments
 (0)