about summary refs log tree commit diff
path: root/src/liballoc/alloc
diff options
context:
space:
mode:
authorbors <bors@rust-lang.org>2019-11-18 19:03:21 +0000
committerbors <bors@rust-lang.org>2019-11-18 19:03:21 +0000
commit3e525e3f6d9e85d54fa4c49b52df85aa0c990100 (patch)
treef33e407c05a06de415002ba3e778c585b7be71ac /src/liballoc/alloc
parenta0d40f8bdfcc3c28355467973f97fd4c45ac5876 (diff)
parent45b83c9164c2462503c2cd381a4b1b85f75fa107 (diff)
downloadrust-3e525e3f6d9e85d54fa4c49b52df85aa0c990100.tar.gz
rust-3e525e3f6d9e85d54fa4c49b52df85aa0c990100.zip
Auto merge of #54733 - GuillaumeGomez:stabilize-rustdoc-theme, r=ollie27,Dylan-DPC
Stabilize rustdoc theme options

Closes #54730

This PR stabilizes the `--themes` (now `--theme`) and `--theme-checker` (now `--check-theme`) options, for allowing users to add custom themes to their documentation.

Rustdoc includes two themes by default: `light` and `dark`. Using the `--theme` option, you can give rustdoc a CSS file to include as an extra theme for that render. Themes are named after the CSS file used, so using `--theme /path/to/your/custom-theme.css` will add a theme called `custom-theme` to the documentation.

Even though the CLI flag to add a theme is getting stabilized, there's no guarantee that a theme file will always have the same effect on documentation generated with future versions of rustdoc. To aid in ensuring that a theme will work, the flag `--check-theme` is also available, which compares the CSS rules defined by a custom theme against the ones used in the `light` theme. If the `light` theme defines a CSS rule that the custom theme does not, rustdoc will report an error. (Rustdoc also performs this check for themes given to `--theme`, but only reports a warning when a difference is found.)
Diffstat (limited to 'src/liballoc/alloc')
0 files changed, 0 insertions, 0 deletions