about summary refs log tree commit diff
path: root/src/doc
diff options
context:
space:
mode:
authorQuietMisdreavus <grey@quietmisdreavus.net>2018-03-16 15:06:36 -0500
committerQuietMisdreavus <grey@quietmisdreavus.net>2018-03-16 15:06:36 -0500
commitb5ab5ceb4b2aa733366ed9453c0e714d6f0cd9f0 (patch)
treec387dda62c799feb3521f011b28569ab416d2be6 /src/doc
parent6b2906018f93a9813392056da4c3de855d92f619 (diff)
downloadrust-b5ab5ceb4b2aa733366ed9453c0e714d6f0cd9f0.tar.gz
rust-b5ab5ceb4b2aa733366ed9453c0e714d6f0cd9f0.zip
talk about --resource-suffix
Diffstat (limited to 'src/doc')
-rw-r--r--src/doc/rustdoc/src/unstable-features.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/src/doc/rustdoc/src/unstable-features.md b/src/doc/rustdoc/src/unstable-features.md
index 3ebc2fa466c..93489f89626 100644
--- a/src/doc/rustdoc/src/unstable-features.md
+++ b/src/doc/rustdoc/src/unstable-features.md
@@ -316,3 +316,16 @@ $ rustdoc -Z unstable-options --theme-checker theme.css
 Before including your theme in crate docs, `rustdoc` will compare all the CSS rules it contains
 against the "main" theme included by default. Using this flag will allow you to see which rules are
 missing if `rustdoc` rejects your theme.
+
+### `--resource-suffix`: modifying the name of CSS/JavaScript in crate docs
+
+Using this flag looks like this:
+
+```bash
+$ rustdoc src/lib.rs -Z unstable-options --resource-suffix suf
+```
+
+When rendering docs, `rustdoc` creates several CSS and JavaScript files as part of the output. Since
+all these files are linked from every page, changing where they are can be cumbersome if you need to
+specially cache them. This flag will rename all these files in the output to include the suffix in
+the filename. For example, `main.css` would become `main-suf.css` with the above command.