diff options
| author | Guillaume Gomez <guillaume1.gomez@gmail.com> | 2019-08-21 15:48:26 +0200 |
|---|---|---|
| committer | Guillaume Gomez <guillaume1.gomez@gmail.com> | 2019-11-18 16:43:48 +0100 |
| commit | bbfd63c89afe091fa9ec75bba0a5721d153d78f3 (patch) | |
| tree | 8775b29dcebfd9fb546b99178e5fb794f5893690 /src/doc | |
| parent | 6f2d1f51eb43bcf555a1b3b71998eb7f18bd87de (diff) | |
| download | rust-bbfd63c89afe091fa9ec75bba0a5721d153d78f3.tar.gz rust-bbfd63c89afe091fa9ec75bba0a5721d153d78f3.zip | |
Improve documentation, add checks for themes option arguments, make sure the themes file names are js compatible
Diffstat (limited to 'src/doc')
| -rw-r--r-- | src/doc/rustdoc/src/command-line-arguments.md | 5 |
1 files changed, 4 insertions, 1 deletions
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 ``` |