Add resource-suffix option for rustdoc #48511

GuillaumeGomez · 2018-02-24T18:15:21Z

Alternative version of #48442.

onur · 2018-03-01T17:34:32Z

Hi @GuillaumeGomez this is great and it will fix docs.rs breakage and save me from a lot of trouble in future. Only javascript portion of theme picker needs some adjustments now.

themes in render.rs should have suffix as well in order to generate correct javascript.
switchTheme function in storage should use rustdoc-SUFFIX.css instead of plain rustdoc.css.

Some example I used to make theme-picker work with --resource-suffix option. I used RUSTDOCFLAGS="-Z unstable-options --resource-suffix -EXAMPLE" cargo doc to generate documentation and here is the working version of javascript portion of this command:

switchTheme:

function switchTheme(styleElem, mainStyleElem, newTheme) {
    styleElem.href = mainStyleElem.href.replace("rustdoc-EXAMPLE.css", newTheme + ".css");
    updateLocalStorage('theme', newTheme);
}

theme-EXAMPLE.js:

["dark-EXAMPLE","main-EXAMPLE"].forEach(function(item) {
    var but = document.createElement('button');
    but.innerHTML = item;
    but.onclick = function(el) {
        switchTheme(currentTheme, mainTheme, item);
    };
    themes.appendChild(but);
});

GuillaumeGomez · 2018-03-03T15:33:18Z

Apparently it's all good for @onur. So therefore, I suppose it can get merged. cc @QuietMisdreavus

onur · 2018-03-03T18:14:52Z

Yes it's all good @GuillaumeGomez. I have some (most likely) unrelated tests failing on docs.rs. Trying to fix them.

Edit: fixed them, they are not related to this.

GuillaumeGomez · 2018-03-04T12:58:24Z

Perfect, now we just need to hear back from @QuietMisdreavus!

QuietMisdreavus

Took me a minute to figure out how the names would get displayed to the users in the theme picker. Since the resource suffix is added into the JS file separately, the theme picker names should stay the same (i.e. without the suffix) so i only have a few comments before i'm willing to sign off on this.

QuietMisdreavus · 2018-03-05T15:35:52Z

src/librustdoc/html/render.rs

        try_err!(fs::copy(css, out), css);
    }
-    write(cx.dst.join("normalize.css"),
+    write(cx.dst.join(&format!("normalize{}.css", cx.shared.resource_suffix)),
          include_bytes!("static/normalize.css"))?;
    write(cx.dst.join("FiraSans-Regular.woff"),


I'm guessing the fonts and their copyright notices aren't relevant for wanting to switch the filenames out?

According to @onur from a conversation on IRC, it matters less for the fonts to handle it, since they're loaded from the CSS (which would need to also be processed to use the suffix), and they don't churn like the CSS/JS do. This is fine as-is.

QuietMisdreavus · 2018-03-05T15:48:43Z

src/librustdoc/html/render.rs

+    {
+        let mut data = format!("var resourcesSuffix = \"{}\";\n",
+                               cx.shared.resource_suffix).into_bytes();
+        data.extend_from_slice(include_bytes!("static/storage.js"));


Using a Vec<u8> and include_bytes here instead of a String and include_str seems weird to me. I get that on the very next line it needs to be bytes for the write call, but i don't know how much we gain by sidesteppning the UTF-8 check on this extend call.

QuietMisdreavus · 2018-03-05T15:53:10Z

src/librustdoc/lib.rs

@@ -261,6 +261,11 @@ pub fn opts() -> Vec<RustcOptGroup> {
                       "check if given theme is valid",
                       "FILES")
        }),
+        unstable("resource-suffix", |o| {
+            o.optopt("",
+                     "resource-suffix", "suffix which will be added at the end of resource files",


This seems odd, both in verb tense and what we mean by "resource files". What about this?

suffix to add to CSS and JavaScript files, e.g. "main.css" will become "main-suffix.css"

It changed through the writing of this PR. Now we have an almost definitive version so it's more clear. I'll update to your sentence.

QuietMisdreavus · 2018-03-05T23:06:37Z

r=me pending travis

GuillaumeGomez · 2018-03-06T09:05:44Z

@bors: r=QuietMisdreavus

bors · 2018-03-06T09:05:45Z

📌 Commit 831009f has been approved by QuietMisdreavus

@onur

…fix, r=QuietMisdreavus Add resource-suffix option for rustdoc Alternative version of rust-lang#48442. cc @onur r? @QuietMisdreavus

@onur

…fix, r=QuietMisdreavus Add resource-suffix option for rustdoc Alternative version of rust-lang#48442. cc @onur r? @QuietMisdreavus

@onur

…fix, r=QuietMisdreavus Add resource-suffix option for rustdoc Alternative version of rust-lang#48442. cc @onur r? @QuietMisdreavus

bors · 2018-03-07T07:29:43Z

⌛ Testing commit 831009f with merge a012ad893062d107b305274a20d56c3a75c25bac...

alexcrichton · 2018-03-07T07:40:47Z

@bors: retry

prioritizing rollup with this in it

Rollup of 9 pull requests - Successful merges: #48511, #48549, #48618, #48624, #48651, #48698, #48778, #48787, #48802 - Failed merges: #48669, #48710

rust-highfive assigned QuietMisdreavus Feb 24, 2018

rust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Feb 24, 2018

This was referenced Feb 27, 2018

Compiler panic while building alga #48542

Closed

Compiler panic while running rayon demo #48568

Closed

onur mentioned this pull request Mar 1, 2018

Crate failed to build rust-lang/docs.rs#23

Closed

GuillaumeGomez force-pushed the rustdoc-resource-suffix branch 4 times, most recently from 17c234c to 2497447 Compare March 1, 2018 22:51

onur mentioned this pull request Mar 2, 2018

rustdoc resource suffix changes rust-lang/docs.rs#182

Merged

2 tasks

GuillaumeGomez mentioned this pull request Mar 3, 2018

Add root-path #48442

Closed

sfleischman105 mentioned this pull request Mar 4, 2018

docs.rs documentation failing pleco-rs/Pleco#81

Closed

QuietMisdreavus reviewed Mar 5, 2018

View reviewed changes

Add resource-suffix option for rustdoc

831009f

GuillaumeGomez force-pushed the rustdoc-resource-suffix branch from 2497447 to 831009f Compare March 5, 2018 22:45

bors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Mar 6, 2018

GuillaumeGomez mentioned this pull request Mar 6, 2018

Rollup of 11 pull requests #48774

Closed

GuillaumeGomez mentioned this pull request Mar 6, 2018

Rollup of 13 pull requests #48776

Closed

alexcrichton mentioned this pull request Mar 7, 2018

Rollup of 9 pull requests #48806

Merged

bors added a commit that referenced this pull request Mar 7, 2018

Auto merge of #48806 - alexcrichton:rollup, r=alexcrichton

6675913

Rollup of 9 pull requests - Successful merges: #48511, #48549, #48618, #48624, #48651, #48698, #48778, #48787, #48802 - Failed merges: #48669, #48710

bors added a commit that referenced this pull request Mar 7, 2018

Auto merge of #48806 - alexcrichton:rollup, r=alexcrichton

29d7fc1

Rollup of 9 pull requests - Successful merges: #48511, #48549, #48618, #48624, #48651, #48698, #48778, #48787, #48802 - Failed merges: #48669, #48710

bors added a commit that referenced this pull request Mar 7, 2018

Auto merge of #48806 - alexcrichton:rollup, r=alexcrichton

5430c0c

Rollup of 9 pull requests - Successful merges: #48511, #48549, #48618, #48624, #48651, #48698, #48778, #48787, #48802 - Failed merges: #48669, #48710

alexcrichton merged commit 831009f into rust-lang:master Mar 8, 2018

GuillaumeGomez deleted the rustdoc-resource-suffix branch March 8, 2018 15:11

onur mentioned this pull request Mar 29, 2018

Provide a way to change path of common css/js paths in documentations #48094

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add resource-suffix option for rustdoc #48511

Add resource-suffix option for rustdoc #48511

GuillaumeGomez commented Feb 24, 2018

onur commented Mar 1, 2018

GuillaumeGomez commented Mar 3, 2018

onur commented Mar 3, 2018 •

edited

Loading

GuillaumeGomez commented Mar 4, 2018

QuietMisdreavus left a comment

QuietMisdreavus Mar 5, 2018

GuillaumeGomez Mar 5, 2018

QuietMisdreavus Mar 5, 2018

QuietMisdreavus Mar 5, 2018

QuietMisdreavus Mar 5, 2018

GuillaumeGomez Mar 5, 2018

QuietMisdreavus commented Mar 5, 2018

GuillaumeGomez commented Mar 6, 2018

bors commented Mar 6, 2018

bors commented Mar 7, 2018

alexcrichton commented Mar 7, 2018

Add resource-suffix option for rustdoc #48511

Add resource-suffix option for rustdoc #48511

Conversation

GuillaumeGomez commented Feb 24, 2018

onur commented Mar 1, 2018

GuillaumeGomez commented Mar 3, 2018

onur commented Mar 3, 2018 • edited Loading

GuillaumeGomez commented Mar 4, 2018

QuietMisdreavus left a comment

Choose a reason for hiding this comment

QuietMisdreavus Mar 5, 2018

Choose a reason for hiding this comment

GuillaumeGomez Mar 5, 2018

Choose a reason for hiding this comment

QuietMisdreavus Mar 5, 2018

Choose a reason for hiding this comment

QuietMisdreavus Mar 5, 2018

Choose a reason for hiding this comment

QuietMisdreavus Mar 5, 2018

Choose a reason for hiding this comment

GuillaumeGomez Mar 5, 2018

Choose a reason for hiding this comment

QuietMisdreavus commented Mar 5, 2018

GuillaumeGomez commented Mar 6, 2018

bors commented Mar 6, 2018

bors commented Mar 7, 2018

alexcrichton commented Mar 7, 2018

onur commented Mar 3, 2018 •

edited

Loading