From bbfd63c89afe091fa9ec75bba0a5721d153d78f3 Mon Sep 17 00:00:00 2001 From: Guillaume Gomez Date: Wed, 21 Aug 2019 15:48:26 +0200 Subject: Improve documentation, add checks for themes option arguments, make sure the themes file names are js compatible --- src/doc/rustdoc/src/command-line-arguments.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) (limited to 'src/doc') diff --git a/src/doc/rustdoc/src/command-line-arguments.md b/src/doc/rustdoc/src/command-line-arguments.md index 5a0a8f76744..1f4584ec564 100644 --- a/src/doc/rustdoc/src/command-line-arguments.md +++ b/src/doc/rustdoc/src/command-line-arguments.md @@ -368,6 +368,9 @@ you'll need to use this flag as follows: $ rustdoc src/lib.rs --themes /path/to/your/theme/file.css ``` +Note that the theme's name will be the file name without its extension. So if you pass +`/path/to/your/theme/file.css` as theme, then the theme's name will be `file`. + ### `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 @@ -377,5 +380,5 @@ CSS theme. You can use this flag like this: ```bash -$ rustdoc src/lib.rs --check-theme /path/to/your/theme/file.css +$ rustdoc --check-theme /path/to/your/theme/file.css ``` -- cgit 1.4.1-3-g733a5