rustdoc: Consolidate static-file replacement mechanism - #91062

Merged
bors merged 3 commits into
rust-lang:masterfrom
jsha:static-file-replace
Nov 27, 2021
Merged

rustdoc: Consolidate static-file replacement mechanism#91062
bors merged 3 commits into
rust-lang:masterfrom
jsha:static-file-replace

Conversation

@jsha

@jshajsha commented Nov 19, 2021•
edited
Loading

Copy link
Copy Markdown
Contributor

There were a few places in rustdoc where we would take static JS or CSS and rewrite it at doc generation time to insert values. This consolidates all the CSS instances into one CSS file and replaces the JS examples with data- attributes on the rustdoc-vars div.

Demo https://rustdoc.crud.net/jsha/static-file-replace/test_docs/

r? @GuillaumeGomez

@jshajsha added T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. A-rustdoc-ui Area: Rustdoc UI (generated HTML) labels Nov 19, 2021
@rust-highfive

rust-highfive commented Nov 19, 2021

Copy link
Copy Markdown
Contributor

Some changes occurred in HTML/CSS/JS.

cc @GuillaumeGomez

@rust-highfiverust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Nov 19, 2021
@rust-log-analyzer

This comment has been minimized.

Sign in to view
@jyn514jyn514 changed the title Consolidate static-file replacement mechanismrustdoc: Consolidate static-file replacement mechanismNov 20, 2021
jyn514
jyn514 reviewed Nov 20, 2021
View reviewed changes
Comment threadsrc/librustdoc/html/render/write_shared.rs Outdated

@jyn514jyn514Nov 20, 2021

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You can remove this FIXME now I think :)

jyn514
jyn514 reviewed Nov 20, 2021
View reviewed changes
Comment threadsrc/librustdoc/html/render/write_shared.rs Outdated

@jyn514jyn514Nov 20, 2021

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm, I think this should be using cx.write_minify(InvocationSpecific), since it can vary from crate to crate. Unfortunately we don't have a good way of testing this before it hits nightly right now.

@jshajshaNov 20, 2021

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The only thing that is invocation specific is the list of themes, right? What if I put those in a data- attribute in the HTML instead? The list is quite short, so duplication is not a big concern.

@jyn514jyn514Nov 20, 2021

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That would be great! Thanks :)

GuillaumeGomez
GuillaumeGomez reviewed Nov 20, 2021
View reviewed changes
Comment threadsrc/librustdoc/html/static/js/storage.js Outdated

@GuillaumeGomezGuillaumeGomezNov 20, 2021

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm a bit worried about this: if we generate docs with two different rustdoc version and/or different suffix, it means the older version will use newer files, which might break the display.

@jshajshaNov 21, 2021

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

storage is stored as a versioned file (e.g. storage1.58.0.js), so it would load the other versioned files that match it.

@GuillaumeGomezGuillaumeGomezNov 21, 2021

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That is, if you use suffix, otherwise you'll simply overwrite.

@jyn514jyn514Nov 21, 2021

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think it's possible for rustdoc alone to prevent conflicting versions with our current setup. If you think that should be a goal, maybe open an issue or MCP but I don't think it makes sense to hold specific parts of rustdoc to a higher standard than others.

@jshajshaNov 21, 2021

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The more I think about it, the more I think it would be cleaner to put each of these three variables in a data- attribute in the HTML, like I proposed in #91062 (comment). The big advantage there is that when you're editing JS you can copy it directly into place without waiting to rebuild rustdoc. I've run into this a number of times just recently.

@GuillaumeGomezGuillaumeGomezNov 21, 2021

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think it's possible for rustdoc alone to prevent conflicting versions with our current setup. If you think that should be a goal, maybe open an issue or MCP but I don't think it makes sense to hold specific parts of rustdoc to a higher standard than others.

It is working currently because the links are set directly in the HTML, not in the JS which is regenerated. This is my biggest issue with this change, moving "hard-coded" HTML content into JS.

@jsha Yes, I think that could work. The added size would be negligible as well.

@jsha
jshaforce-pushed the static-file-replace branch from b424fd8 to 7a5cd2bCompareNovember 24, 2021 05:29
@jsha

jsha commented Nov 24, 2021

Copy link
Copy Markdown
ContributorAuthor

Alright, I switched this up so that main.js isn't rewritten at all - instead, the variables we want are set in the rustdoc-vars div.

One big change along the way: I revamped how stylesheets links are rendered into the HTML (c330963). I think this cleans things up a lot. It also made it much nicer to be able to generate a list of themes in layout.rs.

Also I changed storage.js to not rely on resource_suffix, because rustdoc-vars aren't yet available at the time storage.js runs.

@rust-log-analyzer

This comment has been minimized.

Sign in to view
@jsha
jshaforce-pushed the static-file-replace branch from 7a5cd2b to 276ea81CompareNovember 24, 2021 06:26
@rust-log-analyzer

This comment has been minimized.

Sign in to view
@jsha
jshaforce-pushed the static-file-replace branch from 276ea81 to 57e6fd7CompareNovember 24, 2021 07:47
@jshajsha mentioned this pull request Nov 24, 2021
Merged
bors added a commit to rust-lang-ci/rust that referenced this pull request Nov 24, 2021
@bors
Auto merge ofrust-lang#91171- jsha:fix-rustdoc-gui-test, r=Guillaum…
982c552
…eGomez
Fix toggle-click-deadspace rustdoc-gui test
In rust-lang#91103 I introduced a rustdoc-gui test for clicks on toggles. I introduced some documentation on a method in lib2/struct.Foo.html so there would be something to toggle, but accidentally left the test checking test_docs/struct.Foo.html. That caused the test to reliably fail.
I'm not sure how that test got past GitHub Actions and bors, but it's manifesting in test failures at rust-lang#91062 (comment) and rust-lang#91170 (comment).
This fixes by pointing at the right file.
r? `@GuillaumeGomez`
jyn514
jyn514 approved these changes Nov 24, 2021
View reviewed changes

@jyn514jyn514 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM but I want to give Guillaume a chance to review. Thanks for working on this :)

@GuillaumeGomez

GuillaumeGomez commented Nov 24, 2021

Copy link
Copy Markdown
Member

It looks good to me as well, thanks! You'll need to rebase to make the CI happy. ;)

r=jyn514,GuillaumeGomez once done.

@jyn514jyn514 added S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Nov 24, 2021
@jsha
Simplify rendering of stylesheet links into HTML
3649b90
We carry around a list of stylesheets that can carry two different types
of thing:
1. Internal stylesheets specific to a page type (only for settings)
2. Themes
In this change I move the link generation for settings.css into
settings(), so Context.style_files is reserved just for themes.
We had two places where we extracted a base theme name from a list of
StylePaths. I consolidated that code to be a method on StylePath.
I moved generation of link tags for stylesheets into the page.html
template. With that change, I made the template responsible for special
handling of light.css (making it the default theme) and of the other
themes (marking them disabled). That allowed getting rid of the
`disabled` field on StylePath.
@jsha
Move themes and version into rustdoc-vars
f0683f9
We had been injecting the list of themes and the rustdoc version into
main.js by rewriting it at doc generation time. By avoiding this
rewrite, we can make it easier to edit main.js without regenerating all
the docs.
Added a more convenient accessor for rustdoc-vars.
Changed storage.js to not rely on resourcesSuffix. It could in theory
use rustdoc-vars, but because rustdoc-vars is at the end of the HTML,
it's not available when storage.js runs (very early in page load).
@jsha
Consistentize the system for image URLs in CSS.
d9afca5
@jsha
jshaforce-pushed the static-file-replace branch from 57e6fd7 to d9afca5CompareNovember 25, 2021 04:05
@jsha

jsha commented Nov 27, 2021

Copy link
Copy Markdown
ContributorAuthor

@bors r=jyn514,GuillaumeGomez

@bors

bors commented Nov 27, 2021

Copy link
Copy Markdown
Collaborator

📌 Commit d9afca5 has been approved by jyn514,GuillaumeGomez

@borsbors removed the S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. label Nov 27, 2021
@borsbors added the S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. label Nov 27, 2021
matthiaskrgr added a commit to matthiaskrgr/rust that referenced this pull request Nov 27, 2021
@matthiaskrgr
Rollup merge ofrust-lang#91062- jsha:static-file-replace, r=jyn514,…
bdcc293
…GuillaumeGomez
rustdoc: Consolidate static-file replacement mechanism
There were a few places in rustdoc where we would take static JS or CSS and rewrite it at doc generation time to insert values. This consolidates all the CSS instances into one CSS file and replaces the JS examples with data- attributes on the rustdoc-vars div.
Demo https://rustdoc.crud.net/jsha/static-file-replace/test_docs/
r? `@GuillaumeGomez`
This was referenced Nov 27, 2021
Closed
Merged
bors added a commit to rust-lang-ci/rust that referenced this pull request Nov 27, 2021
@bors
Auto merge ofrust-lang#91288- matthiaskrgr:rollup-yp5h41r, r=matthi…
686e313
…askrgr
Rollup of 6 pull requests
Successful merges:
- rust-lang#83791 (Weaken guarantee around advancing underlying iterators in zip)
- rust-lang#90995 (Document non-guarantees for Hash)
- rust-lang#91057 (Expand `available_parallelism` docs in anticipation of cgroup quota support)
- rust-lang#91062 (rustdoc: Consolidate static-file replacement mechanism)
- rust-lang#91208 (Account for incorrect `where T::Assoc = Ty` bound)
- rust-lang#91266 (Use non-generic inner function for pointer formatting)
Failed merges:
r? `@ghost`
`@rustbot` modify labels: rollup
@bors
bors merged commit 55f8b5f into rust-lang:masterNov 27, 2021
@rustbotrustbot added this to the 1.59.0 milestone Nov 27, 2021
@camelidcamelid mentioned this pull request Nov 28, 2021
Closed
@jsha
jsha deleted the static-file-replace branch November 28, 2021 04:52
@Folyd

Folyd commented Dec 7, 2021

Copy link
Copy Markdown
Contributor

Ohhh, this PR broke my extension huhu/rust-search-extension#134. 😅
Rust search extension relies on the search-index.js. I hope we can keep the search-index.js loading steadily. Would you mind CC me if the search-index.js loading method has changed? Thanks. ❤️ @jsha@GuillaumeGomez

@jyn514

jyn514 commented Dec 7, 2021

Copy link
Copy Markdown
Member

@Folyd you can set up an automatic ping in the highfive bot if you like - here's an example: https://github.com/rust-lang/highfive/blob/6e2c21639aaeafaeae423b244d353247c507d46a/highfive/configs/rust-lang/rust.json#L134

Folyd added a commit to Folyd/highfive that referenced this pull request Dec 7, 2021
@Folyd
Add new reviewer to librustdoc static files
747b4c4
Ping @Folyd if some changes occurred in librustdoc's HTML/CSS/JS.
Related context: rust-lang/rust#91062 (comment)
@FolydFolyd mentioned this pull request Dec 7, 2021
Merged
@yvtyvt mentioned this pull request Aug 19, 2022
Open
@sypharsyphar mentioned this pull request Dec 28, 2022
Open
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@GuillaumeGomezGuillaumeGomezGuillaumeGomez approved these changes
+1 more reviewer
@jyn514jyn514jyn514 approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

@GuillaumeGomezGuillaumeGomez

Labels

A-rustdoc-uiArea: Rustdoc UI (generated HTML)S-waiting-on-borsStatus: Waiting on bors to run and complete tests. Bors will change the label on completion.T-rustdocRelevant to the rustdoc team, which will review and decide on the PR/issue.

Projects

None yet

Milestone

1.59.0

Development

Successfully merging this pull request may close these issues.

8 participants

@jsha@rust-highfive@rust-log-analyzer@GuillaumeGomez@bors@Folyd@jyn514@rustbot
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
rustdoc: Consolidate static-file replacement mechanism - #91062
Merged
bors merged 3 commits into
rust-lang:masterfrom 
jsha:static-file-replace
Nov 27, 2021
Merged
rustdoc: Consolidate static-file replacement mechanism#91062
bors merged 3 commits into
rust-lang:masterfrom 
jsha:static-file-replace
Conversation
@jsha
@jshajsha
commented
Nov 19, 2021•

edited

Loading

Copy link


Copy Markdown

Contributor
There were a few places in rustdoc where we would take static JS or CSS and rewrite it at doc generation time to insert values. This consolidates all the CSS instances into one CSS file and replaces the JS examples with data- attributes on the rustdoc-vars div.
Demo https://rustdoc.crud.net/jsha/static-file-replace/test_docs/
r? @GuillaumeGomez
@jshajsha
added

T-rustdoc
Relevant to the rustdoc team, which will review and decide on the PR/issue.
A-rustdoc-ui
Area: Rustdoc UI (generated HTML)
labels
Nov 19, 2021
@rust-highfive
rust-highfive
commented
Nov 19, 2021

Copy link


Copy Markdown

Contributor
Some changes occurred in HTML/CSS/JS.
cc @GuillaumeGomez
@rust-highfiverust-highfive
added
the 
S-waiting-on-review
Status: Awaiting review from the assignee but also interested parties.
label
Nov 19, 2021
@rust-log-analyzer

This comment has been minimized.

Sign in to view
@jyn514jyn514
changed the title
Consolidate static-file replacement mechanismrustdoc: Consolidate static-file replacement mechanismNov 20, 2021
jyn514
jyn514
reviewed
Nov 20, 2021
View reviewed changes
Comment threadsrc/librustdoc/html/render/write_shared.rs
Outdated

@jyn514jyn514Nov 20, 2021

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You can remove this FIXME now I think :)
jyn514
jyn514
reviewed
Nov 20, 2021
View reviewed changes
Comment threadsrc/librustdoc/html/render/write_shared.rs
Outdated

@jyn514jyn514Nov 20, 2021

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm, I think this should be using cx.write_minify(InvocationSpecific), since it can vary from crate to crate. Unfortunately we don't have a good way of testing this before it hits nightly right now.
@jshajshaNov 20, 2021

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The only thing that is invocation specific is the list of themes, right? What if I put those in a data- attribute in the HTML instead? The list is quite short, so duplication is not a big concern.
@jyn514jyn514Nov 20, 2021

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That would be great! Thanks :)
GuillaumeGomez
GuillaumeGomez
reviewed
Nov 20, 2021
View reviewed changes
Comment threadsrc/librustdoc/html/static/js/storage.js
Outdated

@GuillaumeGomezGuillaumeGomezNov 20, 2021

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm a bit worried about this: if we generate docs with two different rustdoc version and/or different suffix, it means the older version will use newer files, which might break the display.
@jshajshaNov 21, 2021

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

storage is stored as a versioned file (e.g. storage1.58.0.js), so it would load the other versioned files that match it.
@GuillaumeGomezGuillaumeGomezNov 21, 2021

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That is, if you use suffix, otherwise you'll simply overwrite.
@jyn514jyn514Nov 21, 2021

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think it's possible for rustdoc alone to prevent conflicting versions with our current setup. If you think that should be a goal, maybe open an issue or MCP but I don't think it makes sense to hold specific parts of rustdoc to a higher standard than others.
@jshajshaNov 21, 2021

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The more I think about it, the more I think it would be cleaner to put each of these three variables in a data- attribute in the HTML, like I proposed in #91062 (comment). The big advantage there is that when you're editing JS you can copy it directly into place without waiting to rebuild rustdoc. I've run into this a number of times just recently.
@GuillaumeGomezGuillaumeGomezNov 21, 2021

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think it's possible for rustdoc alone to prevent conflicting versions with our current setup. If you think that should be a goal, maybe open an issue or MCP but I don't think it makes sense to hold specific parts of rustdoc to a higher standard than others.
It is working currently because the links are set directly in the HTML, not in the JS which is regenerated. This is my biggest issue with this change, moving "hard-coded" HTML content into JS.
@jsha Yes, I think that could work. The added size would be negligible as well.
@jsha
jshaforce-pushed
the
static-file-replace
branch
from
b424fd8 to
7a5cd2bCompareNovember 24, 2021 05:29
@jsha
jsha
commented
Nov 24, 2021

Copy link


Copy Markdown

ContributorAuthor
Alright, I switched this up so that main.js isn't rewritten at all - instead, the variables we want are set in the rustdoc-vars div.
One big change along the way: I revamped how stylesheets links are rendered into the HTML (c330963). I think this cleans things up a lot. It also made it much nicer to be able to generate a list of themes in layout.rs.
Also I changed storage.js to not rely on resource_suffix, because rustdoc-vars aren't yet available at the time storage.js runs.
@rust-log-analyzer

This comment has been minimized.

Sign in to view
@jsha
jshaforce-pushed
the
static-file-replace
branch
from
7a5cd2b to
276ea81CompareNovember 24, 2021 06:26
@rust-log-analyzer

This comment has been minimized.

Sign in to view
@jsha
jshaforce-pushed
the
static-file-replace
branch
from
276ea81 to
57e6fd7CompareNovember 24, 2021 07:47
@jshajsha
mentioned this pull request
Nov 24, 2021
 Merged

bors added a commit
to rust-lang-ci/rust
that referenced
this pull request
Nov 24, 2021
@bors
Auto merge ofrust-lang#91171- jsha:fix-rustdoc-gui-test, r=Guillaum…
982c552
…eGomez
Fix toggle-click-deadspace rustdoc-gui test
In rust-lang#91103 I introduced a rustdoc-gui test for clicks on toggles. I introduced some documentation on a method in lib2/struct.Foo.html so there would be something to toggle, but accidentally left the test checking test_docs/struct.Foo.html. That caused the test to reliably fail.
I'm not sure how that test got past GitHub Actions and bors, but it's manifesting in test failures at rust-lang#91062 (comment) and rust-lang#91170 (comment).
This fixes by pointing at the right file.
r? `@GuillaumeGomez`
jyn514
jyn514
approved these changes
Nov 24, 2021
View reviewed changes
@jyn514jyn514
left a comment


Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM but I want to give Guillaume a chance to review. Thanks for working on this :)
@GuillaumeGomez
GuillaumeGomez
commented
Nov 24, 2021

Copy link


Copy Markdown

Member
It looks good to me as well, thanks! You'll need to rebase to make the CI happy. ;)
r=jyn514,GuillaumeGomez once done.
@jyn514jyn514
added

S-waiting-on-author
Status: This is awaiting some action (such as code changes or more information) from the author.
and removed

S-waiting-on-review
Status: Awaiting review from the assignee but also interested parties.
labels
Nov 24, 2021
@jsha
Simplify rendering of stylesheet links into HTML
3649b90
We carry around a list of stylesheets that can carry two different types
of thing:
1. Internal stylesheets specific to a page type (only for settings)
2. Themes
In this change I move the link generation for settings.css into
settings(), so Context.style_files is reserved just for themes.
We had two places where we extracted a base theme name from a list of
StylePaths. I consolidated that code to be a method on StylePath.
I moved generation of link tags for stylesheets into the page.html
template. With that change, I made the template responsible for special
handling of light.css (making it the default theme) and of the other
themes (marking them disabled). That allowed getting rid of the
`disabled` field on StylePath.
@jsha
Move themes and version into rustdoc-vars
f0683f9
We had been injecting the list of themes and the rustdoc version into
main.js by rewriting it at doc generation time. By avoiding this
rewrite, we can make it easier to edit main.js without regenerating all
the docs.
Added a more convenient accessor for rustdoc-vars.
Changed storage.js to not rely on resourcesSuffix. It could in theory
use rustdoc-vars, but because rustdoc-vars is at the end of the HTML,
it's not available when storage.js runs (very early in page load).
@jsha
Consistentize the system for image URLs in CSS.
d9afca5
@jsha
jshaforce-pushed
the
static-file-replace
branch
from
57e6fd7 to
d9afca5CompareNovember 25, 2021 04:05
@jsha
jsha
commented
Nov 27, 2021

Copy link


Copy Markdown

ContributorAuthor
@bors r=jyn514,GuillaumeGomez
@bors
bors
commented
Nov 27, 2021

Copy link


Copy Markdown

Collaborator
📌 Commit d9afca5 has been approved by jyn514,GuillaumeGomez
@borsbors
removed
the 
S-waiting-on-author
Status: This is awaiting some action (such as code changes or more information) from the author.
label
Nov 27, 2021
@borsbors
added
the 
S-waiting-on-bors
Status: Waiting on bors to run and complete tests. Bors will change the label on completion.
label
Nov 27, 2021
matthiaskrgr added a commit
to matthiaskrgr/rust
that referenced
this pull request
Nov 27, 2021
@matthiaskrgr
Rollup merge ofrust-lang#91062- jsha:static-file-replace, r=jyn514,…
bdcc293
…GuillaumeGomez
rustdoc: Consolidate static-file replacement mechanism
There were a few places in rustdoc where we would take static JS or CSS and rewrite it at doc generation time to insert values. This consolidates all the CSS instances into one CSS file and replaces the JS examples with data- attributes on the rustdoc-vars div.
Demo https://rustdoc.crud.net/jsha/static-file-replace/test_docs/
r? `@GuillaumeGomez`

This was referenced Nov 27, 2021
 Closed

 Merged

bors added a commit
to rust-lang-ci/rust
that referenced
this pull request
Nov 27, 2021
@bors
Auto merge ofrust-lang#91288- matthiaskrgr:rollup-yp5h41r, r=matthi…
686e313
…askrgr
Rollup of 6 pull requests
Successful merges:
- rust-lang#83791 (Weaken guarantee around advancing underlying iterators in zip)
- rust-lang#90995 (Document non-guarantees for Hash)
- rust-lang#91057 (Expand `available_parallelism` docs in anticipation of cgroup quota support)
- rust-lang#91062 (rustdoc: Consolidate static-file replacement mechanism)
- rust-lang#91208 (Account for incorrect `where T::Assoc = Ty` bound)
- rust-lang#91266 (Use non-generic inner function for pointer formatting)
Failed merges:
r? `@ghost`
`@rustbot` modify labels: rollup
@bors
bors
merged commit 55f8b5f
into
rust-lang:masterNov 27, 2021
@rustbotrustbot
added this to the 1.59.0 milestone
Nov 27, 2021
@camelidcamelid
mentioned this pull request
Nov 28, 2021

Closed

@jsha
jsha
deleted the

static-file-replace

branch
November 28, 2021 04:52
@Folyd
Folyd
commented
Dec 7, 2021

Copy link


Copy Markdown

Contributor
Ohhh, this PR broke my extension huhu/rust-search-extension#134. 😅
Rust search extension relies on the search-index.js. I hope we can keep the search-index.js loading steadily. Would you mind CC me if the search-index.js loading method has changed? Thanks. ❤️ @jsha@GuillaumeGomez
@jyn514
jyn514
commented
Dec 7, 2021

Copy link


Copy Markdown

Member
@Folyd you can set up an automatic ping in the highfive bot if you like - here's an example: https://github.com/rust-lang/highfive/blob/6e2c21639aaeafaeae423b244d353247c507d46a/highfive/configs/rust-lang/rust.json#L134
Folyd added a commit
to Folyd/highfive
that referenced
this pull request
Dec 7, 2021
@Folyd
Add new reviewer to librustdoc static files
747b4c4
Ping @Folyd if some changes occurred in librustdoc's HTML/CSS/JS.
Related context: rust-lang/rust#91062 (comment)
@FolydFolyd
mentioned this pull request
Dec 7, 2021
 Merged

@yvtyvt
mentioned this pull request
Aug 19, 2022

Open

@sypharsyphar
mentioned this pull request
Dec 28, 2022

Open

Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@GuillaumeGomezGuillaumeGomezGuillaumeGomez approved these changes

+1 more reviewer

@jyn514jyn514jyn514 approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

@GuillaumeGomezGuillaumeGomez

Labels

A-rustdoc-uiArea: Rustdoc UI (generated HTML)S-waiting-on-borsStatus: Waiting on bors to run and complete tests. Bors will change the label on completion.T-rustdocRelevant to the rustdoc team, which will review and decide on the PR/issue.

Projects


None yet


Milestone

1.59.0

Development

Successfully merging this pull request may close these issues.

8 participants

@jsha@rust-highfive@rust-log-analyzer@GuillaumeGomez@bors@Folyd@jyn514@rustbot

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
rustdoc: Consolidate static-file replacement mechanism - #91062
Merged
bors merged 3 commits into
rust-lang:masterfrom 
jsha:static-file-replace
Nov 27, 2021
Merged
rustdoc: Consolidate static-file replacement mechanism#91062
bors merged 3 commits into
rust-lang:masterfrom 
jsha:static-file-replace
Conversation
@jsha
@jshajsha
commented
Nov 19, 2021•

edited

Loading

Copy link


Copy Markdown

Contributor
There were a few places in rustdoc where we would take static JS or CSS and rewrite it at doc generation time to insert values. This consolidates all the CSS instances into one CSS file and replaces the JS examples with data- attributes on the rustdoc-vars div.
Demo https://rustdoc.crud.net/jsha/static-file-replace/test_docs/
r? @GuillaumeGomez
@jshajsha
added

T-rustdoc
Relevant to the rustdoc team, which will review and decide on the PR/issue.
A-rustdoc-ui
Area: Rustdoc UI (generated HTML)
labels
Nov 19, 2021
@rust-highfive
rust-highfive
commented
Nov 19, 2021

Copy link


Copy Markdown

Contributor
Some changes occurred in HTML/CSS/JS.
cc @GuillaumeGomez
@rust-highfiverust-highfive
added
the 
S-waiting-on-review
Status: Awaiting review from the assignee but also interested parties.
label
Nov 19, 2021
@rust-log-analyzer

This comment has been minimized.

Sign in to view
@jyn514jyn514
changed the title
Consolidate static-file replacement mechanismrustdoc: Consolidate static-file replacement mechanismNov 20, 2021
jyn514
jyn514
reviewed
Nov 20, 2021
View reviewed changes
Comment threadsrc/librustdoc/html/render/write_shared.rs
Outdated

@jyn514jyn514Nov 20, 2021

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You can remove this FIXME now I think :)
jyn514
jyn514
reviewed
Nov 20, 2021
View reviewed changes
Comment threadsrc/librustdoc/html/render/write_shared.rs
Outdated

@jyn514jyn514Nov 20, 2021

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm, I think this should be using cx.write_minify(InvocationSpecific), since it can vary from crate to crate. Unfortunately we don't have a good way of testing this before it hits nightly right now.
@jshajshaNov 20, 2021

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The only thing that is invocation specific is the list of themes, right? What if I put those in a data- attribute in the HTML instead? The list is quite short, so duplication is not a big concern.
@jyn514jyn514Nov 20, 2021

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That would be great! Thanks :)
GuillaumeGomez
GuillaumeGomez
reviewed
Nov 20, 2021
View reviewed changes
Comment threadsrc/librustdoc/html/static/js/storage.js
Outdated

@GuillaumeGomezGuillaumeGomezNov 20, 2021

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm a bit worried about this: if we generate docs with two different rustdoc version and/or different suffix, it means the older version will use newer files, which might break the display.
@jshajshaNov 21, 2021

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

storage is stored as a versioned file (e.g. storage1.58.0.js), so it would load the other versioned files that match it.
@GuillaumeGomezGuillaumeGomezNov 21, 2021

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That is, if you use suffix, otherwise you'll simply overwrite.
@jyn514jyn514Nov 21, 2021

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think it's possible for rustdoc alone to prevent conflicting versions with our current setup. If you think that should be a goal, maybe open an issue or MCP but I don't think it makes sense to hold specific parts of rustdoc to a higher standard than others.
@jshajshaNov 21, 2021

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The more I think about it, the more I think it would be cleaner to put each of these three variables in a data- attribute in the HTML, like I proposed in #91062 (comment). The big advantage there is that when you're editing JS you can copy it directly into place without waiting to rebuild rustdoc. I've run into this a number of times just recently.
@GuillaumeGomezGuillaumeGomezNov 21, 2021

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think it's possible for rustdoc alone to prevent conflicting versions with our current setup. If you think that should be a goal, maybe open an issue or MCP but I don't think it makes sense to hold specific parts of rustdoc to a higher standard than others.
It is working currently because the links are set directly in the HTML, not in the JS which is regenerated. This is my biggest issue with this change, moving "hard-coded" HTML content into JS.
@jsha Yes, I think that could work. The added size would be negligible as well.
@jsha
jshaforce-pushed
the
static-file-replace
branch
from
b424fd8 to
7a5cd2bCompareNovember 24, 2021 05:29
@jsha
jsha
commented
Nov 24, 2021

Copy link


Copy Markdown

ContributorAuthor
Alright, I switched this up so that main.js isn't rewritten at all - instead, the variables we want are set in the rustdoc-vars div.
One big change along the way: I revamped how stylesheets links are rendered into the HTML (c330963). I think this cleans things up a lot. It also made it much nicer to be able to generate a list of themes in layout.rs.
Also I changed storage.js to not rely on resource_suffix, because rustdoc-vars aren't yet available at the time storage.js runs.
@rust-log-analyzer

This comment has been minimized.

Sign in to view
@jsha
jshaforce-pushed
the
static-file-replace
branch
from
7a5cd2b to
276ea81CompareNovember 24, 2021 06:26
@rust-log-analyzer

This comment has been minimized.

Sign in to view
@jsha
jshaforce-pushed
the
static-file-replace
branch
from
276ea81 to
57e6fd7CompareNovember 24, 2021 07:47
@jshajsha
mentioned this pull request
Nov 24, 2021
 Merged

bors added a commit
to rust-lang-ci/rust
that referenced
this pull request
Nov 24, 2021
@bors
Auto merge ofrust-lang#91171- jsha:fix-rustdoc-gui-test, r=Guillaum…
982c552
…eGomez
Fix toggle-click-deadspace rustdoc-gui test
In rust-lang#91103 I introduced a rustdoc-gui test for clicks on toggles. I introduced some documentation on a method in lib2/struct.Foo.html so there would be something to toggle, but accidentally left the test checking test_docs/struct.Foo.html. That caused the test to reliably fail.
I'm not sure how that test got past GitHub Actions and bors, but it's manifesting in test failures at rust-lang#91062 (comment) and rust-lang#91170 (comment).
This fixes by pointing at the right file.
r? `@GuillaumeGomez`
jyn514
jyn514
approved these changes
Nov 24, 2021
View reviewed changes
@jyn514jyn514
left a comment


Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM but I want to give Guillaume a chance to review. Thanks for working on this :)
@GuillaumeGomez
GuillaumeGomez
commented
Nov 24, 2021

Copy link


Copy Markdown

Member
It looks good to me as well, thanks! You'll need to rebase to make the CI happy. ;)
r=jyn514,GuillaumeGomez once done.
@jyn514jyn514
added

S-waiting-on-author
Status: This is awaiting some action (such as code changes or more information) from the author.
and removed

S-waiting-on-review
Status: Awaiting review from the assignee but also interested parties.
labels
Nov 24, 2021
@jsha
Simplify rendering of stylesheet links into HTML
3649b90
We carry around a list of stylesheets that can carry two different types
of thing:
1. Internal stylesheets specific to a page type (only for settings)
2. Themes
In this change I move the link generation for settings.css into
settings(), so Context.style_files is reserved just for themes.
We had two places where we extracted a base theme name from a list of
StylePaths. I consolidated that code to be a method on StylePath.
I moved generation of link tags for stylesheets into the page.html
template. With that change, I made the template responsible for special
handling of light.css (making it the default theme) and of the other
themes (marking them disabled). That allowed getting rid of the
`disabled` field on StylePath.
@jsha
Move themes and version into rustdoc-vars
f0683f9
We had been injecting the list of themes and the rustdoc version into
main.js by rewriting it at doc generation time. By avoiding this
rewrite, we can make it easier to edit main.js without regenerating all
the docs.
Added a more convenient accessor for rustdoc-vars.
Changed storage.js to not rely on resourcesSuffix. It could in theory
use rustdoc-vars, but because rustdoc-vars is at the end of the HTML,
it's not available when storage.js runs (very early in page load).
@jsha
Consistentize the system for image URLs in CSS.
d9afca5
@jsha
jshaforce-pushed
the
static-file-replace
branch
from
57e6fd7 to
d9afca5CompareNovember 25, 2021 04:05
@jsha
jsha
commented
Nov 27, 2021

Copy link


Copy Markdown

ContributorAuthor
@bors r=jyn514,GuillaumeGomez
@bors
bors
commented
Nov 27, 2021

Copy link


Copy Markdown

Collaborator
📌 Commit d9afca5 has been approved by jyn514,GuillaumeGomez
@borsbors
removed
the 
S-waiting-on-author
Status: This is awaiting some action (such as code changes or more information) from the author.
label
Nov 27, 2021
@borsbors
added
the 
S-waiting-on-bors
Status: Waiting on bors to run and complete tests. Bors will change the label on completion.
label
Nov 27, 2021
matthiaskrgr added a commit
to matthiaskrgr/rust
that referenced
this pull request
Nov 27, 2021
@matthiaskrgr
Rollup merge ofrust-lang#91062- jsha:static-file-replace, r=jyn514,…
bdcc293
…GuillaumeGomez
rustdoc: Consolidate static-file replacement mechanism
There were a few places in rustdoc where we would take static JS or CSS and rewrite it at doc generation time to insert values. This consolidates all the CSS instances into one CSS file and replaces the JS examples with data- attributes on the rustdoc-vars div.
Demo https://rustdoc.crud.net/jsha/static-file-replace/test_docs/
r? `@GuillaumeGomez`

This was referenced Nov 27, 2021
 Closed

 Merged

bors added a commit
to rust-lang-ci/rust
that referenced
this pull request
Nov 27, 2021
@bors
Auto merge ofrust-lang#91288- matthiaskrgr:rollup-yp5h41r, r=matthi…
686e313
…askrgr
Rollup of 6 pull requests
Successful merges:
- rust-lang#83791 (Weaken guarantee around advancing underlying iterators in zip)
- rust-lang#90995 (Document non-guarantees for Hash)
- rust-lang#91057 (Expand `available_parallelism` docs in anticipation of cgroup quota support)
- rust-lang#91062 (rustdoc: Consolidate static-file replacement mechanism)
- rust-lang#91208 (Account for incorrect `where T::Assoc = Ty` bound)
- rust-lang#91266 (Use non-generic inner function for pointer formatting)
Failed merges:
r? `@ghost`
`@rustbot` modify labels: rollup
@bors
bors
merged commit 55f8b5f
into
rust-lang:masterNov 27, 2021
@rustbotrustbot
added this to the 1.59.0 milestone
Nov 27, 2021
@camelidcamelid
mentioned this pull request
Nov 28, 2021

Closed

@jsha
jsha
deleted the

static-file-replace

branch
November 28, 2021 04:52
@Folyd
Folyd
commented
Dec 7, 2021

Copy link


Copy Markdown

Contributor
Ohhh, this PR broke my extension huhu/rust-search-extension#134. 😅
Rust search extension relies on the search-index.js. I hope we can keep the search-index.js loading steadily. Would you mind CC me if the search-index.js loading method has changed? Thanks. ❤️ @jsha@GuillaumeGomez
@jyn514
jyn514
commented
Dec 7, 2021

Copy link


Copy Markdown

Member
@Folyd you can set up an automatic ping in the highfive bot if you like - here's an example: https://github.com/rust-lang/highfive/blob/6e2c21639aaeafaeae423b244d353247c507d46a/highfive/configs/rust-lang/rust.json#L134
Folyd added a commit
to Folyd/highfive
that referenced
this pull request
Dec 7, 2021
@Folyd
Add new reviewer to librustdoc static files
747b4c4
Ping @Folyd if some changes occurred in librustdoc's HTML/CSS/JS.
Related context: rust-lang/rust#91062 (comment)
@FolydFolyd
mentioned this pull request
Dec 7, 2021
 Merged

@yvtyvt
mentioned this pull request
Aug 19, 2022

Open

@sypharsyphar
mentioned this pull request
Dec 28, 2022

Open

Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@GuillaumeGomezGuillaumeGomezGuillaumeGomez approved these changes

+1 more reviewer

@jyn514jyn514jyn514 approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

@GuillaumeGomezGuillaumeGomez

Labels

A-rustdoc-uiArea: Rustdoc UI (generated HTML)S-waiting-on-borsStatus: Waiting on bors to run and complete tests. Bors will change the label on completion.T-rustdocRelevant to the rustdoc team, which will review and decide on the PR/issue.

Projects


None yet


Milestone

1.59.0

Development

Successfully merging this pull request may close these issues.

8 participants

@jsha@rust-highfive@rust-log-analyzer@GuillaumeGomez@bors@Folyd@jyn514@rustbot

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
rustdoc: Consolidate static-file replacement mechanism - #91062
Merged
bors merged 3 commits into
rust-lang:masterfrom 
jsha:static-file-replace
Nov 27, 2021
Merged
rustdoc: Consolidate static-file replacement mechanism#91062
bors merged 3 commits into
rust-lang:masterfrom 
jsha:static-file-replace
Conversation
@jsha
@jshajsha
commented
Nov 19, 2021•

edited

Loading

Copy link


Copy Markdown

Contributor
There were a few places in rustdoc where we would take static JS or CSS and rewrite it at doc generation time to insert values. This consolidates all the CSS instances into one CSS file and replaces the JS examples with data- attributes on the rustdoc-vars div.
Demo https://rustdoc.crud.net/jsha/static-file-replace/test_docs/
r? @GuillaumeGomez
@jshajsha
added

T-rustdoc
Relevant to the rustdoc team, which will review and decide on the PR/issue.
A-rustdoc-ui
Area: Rustdoc UI (generated HTML)
labels
Nov 19, 2021
@rust-highfive
rust-highfive
commented
Nov 19, 2021

Copy link


Copy Markdown

Contributor
Some changes occurred in HTML/CSS/JS.
cc @GuillaumeGomez
@rust-highfiverust-highfive
added
the 
S-waiting-on-review
Status: Awaiting review from the assignee but also interested parties.
label
Nov 19, 2021
@rust-log-analyzer

This comment has been minimized.

Sign in to view
@jyn514jyn514
changed the title
Consolidate static-file replacement mechanismrustdoc: Consolidate static-file replacement mechanismNov 20, 2021
jyn514
jyn514
reviewed
Nov 20, 2021
View reviewed changes
Comment threadsrc/librustdoc/html/render/write_shared.rs
Outdated

@jyn514jyn514Nov 20, 2021

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You can remove this FIXME now I think :)
jyn514
jyn514
reviewed
Nov 20, 2021
View reviewed changes
Comment threadsrc/librustdoc/html/render/write_shared.rs
Outdated

@jyn514jyn514Nov 20, 2021

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm, I think this should be using cx.write_minify(InvocationSpecific), since it can vary from crate to crate. Unfortunately we don't have a good way of testing this before it hits nightly right now.
@jshajshaNov 20, 2021

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The only thing that is invocation specific is the list of themes, right? What if I put those in a data- attribute in the HTML instead? The list is quite short, so duplication is not a big concern.
@jyn514jyn514Nov 20, 2021

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That would be great! Thanks :)
GuillaumeGomez
GuillaumeGomez
reviewed
Nov 20, 2021
View reviewed changes
Comment threadsrc/librustdoc/html/static/js/storage.js
Outdated

@GuillaumeGomezGuillaumeGomezNov 20, 2021

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm a bit worried about this: if we generate docs with two different rustdoc version and/or different suffix, it means the older version will use newer files, which might break the display.
@jshajshaNov 21, 2021

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

storage is stored as a versioned file (e.g. storage1.58.0.js), so it would load the other versioned files that match it.
@GuillaumeGomezGuillaumeGomezNov 21, 2021

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That is, if you use suffix, otherwise you'll simply overwrite.
@jyn514jyn514Nov 21, 2021

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think it's possible for rustdoc alone to prevent conflicting versions with our current setup. If you think that should be a goal, maybe open an issue or MCP but I don't think it makes sense to hold specific parts of rustdoc to a higher standard than others.
@jshajshaNov 21, 2021

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The more I think about it, the more I think it would be cleaner to put each of these three variables in a data- attribute in the HTML, like I proposed in #91062 (comment). The big advantage there is that when you're editing JS you can copy it directly into place without waiting to rebuild rustdoc. I've run into this a number of times just recently.
@GuillaumeGomezGuillaumeGomezNov 21, 2021

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think it's possible for rustdoc alone to prevent conflicting versions with our current setup. If you think that should be a goal, maybe open an issue or MCP but I don't think it makes sense to hold specific parts of rustdoc to a higher standard than others.
It is working currently because the links are set directly in the HTML, not in the JS which is regenerated. This is my biggest issue with this change, moving "hard-coded" HTML content into JS.
@jsha Yes, I think that could work. The added size would be negligible as well.
@jsha
jshaforce-pushed
the
static-file-replace
branch
from
b424fd8 to
7a5cd2bCompareNovember 24, 2021 05:29
@jsha
jsha
commented
Nov 24, 2021

Copy link


Copy Markdown

ContributorAuthor
Alright, I switched this up so that main.js isn't rewritten at all - instead, the variables we want are set in the rustdoc-vars div.
One big change along the way: I revamped how stylesheets links are rendered into the HTML (c330963). I think this cleans things up a lot. It also made it much nicer to be able to generate a list of themes in layout.rs.
Also I changed storage.js to not rely on resource_suffix, because rustdoc-vars aren't yet available at the time storage.js runs.
@rust-log-analyzer

This comment has been minimized.

Sign in to view
@jsha
jshaforce-pushed
the
static-file-replace
branch
from
7a5cd2b to
276ea81CompareNovember 24, 2021 06:26
@rust-log-analyzer

This comment has been minimized.

Sign in to view
@jsha
jshaforce-pushed
the
static-file-replace
branch
from
276ea81 to
57e6fd7CompareNovember 24, 2021 07:47
@jshajsha
mentioned this pull request
Nov 24, 2021
 Merged

bors added a commit
to rust-lang-ci/rust
that referenced
this pull request
Nov 24, 2021
@bors
Auto merge ofrust-lang#91171- jsha:fix-rustdoc-gui-test, r=Guillaum…
982c552
…eGomez
Fix toggle-click-deadspace rustdoc-gui test
In rust-lang#91103 I introduced a rustdoc-gui test for clicks on toggles. I introduced some documentation on a method in lib2/struct.Foo.html so there would be something to toggle, but accidentally left the test checking test_docs/struct.Foo.html. That caused the test to reliably fail.
I'm not sure how that test got past GitHub Actions and bors, but it's manifesting in test failures at rust-lang#91062 (comment) and rust-lang#91170 (comment).
This fixes by pointing at the right file.
r? `@GuillaumeGomez`
jyn514
jyn514
approved these changes
Nov 24, 2021
View reviewed changes
@jyn514jyn514
left a comment


Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM but I want to give Guillaume a chance to review. Thanks for working on this :)
@GuillaumeGomez
GuillaumeGomez
commented
Nov 24, 2021

Copy link


Copy Markdown

Member
It looks good to me as well, thanks! You'll need to rebase to make the CI happy. ;)
r=jyn514,GuillaumeGomez once done.
@jyn514jyn514
added

S-waiting-on-author
Status: This is awaiting some action (such as code changes or more information) from the author.
and removed

S-waiting-on-review
Status: Awaiting review from the assignee but also interested parties.
labels
Nov 24, 2021
@jsha
Simplify rendering of stylesheet links into HTML
3649b90
We carry around a list of stylesheets that can carry two different types
of thing:
1. Internal stylesheets specific to a page type (only for settings)
2. Themes
In this change I move the link generation for settings.css into
settings(), so Context.style_files is reserved just for themes.
We had two places where we extracted a base theme name from a list of
StylePaths. I consolidated that code to be a method on StylePath.
I moved generation of link tags for stylesheets into the page.html
template. With that change, I made the template responsible for special
handling of light.css (making it the default theme) and of the other
themes (marking them disabled). That allowed getting rid of the
`disabled` field on StylePath.
@jsha
Move themes and version into rustdoc-vars
f0683f9
We had been injecting the list of themes and the rustdoc version into
main.js by rewriting it at doc generation time. By avoiding this
rewrite, we can make it easier to edit main.js without regenerating all
the docs.
Added a more convenient accessor for rustdoc-vars.
Changed storage.js to not rely on resourcesSuffix. It could in theory
use rustdoc-vars, but because rustdoc-vars is at the end of the HTML,
it's not available when storage.js runs (very early in page load).
@jsha
Consistentize the system for image URLs in CSS.
d9afca5
@jsha
jshaforce-pushed
the
static-file-replace
branch
from
57e6fd7 to
d9afca5CompareNovember 25, 2021 04:05
@jsha
jsha
commented
Nov 27, 2021

Copy link


Copy Markdown

ContributorAuthor
@bors r=jyn514,GuillaumeGomez
@bors
bors
commented
Nov 27, 2021

Copy link


Copy Markdown

Collaborator
📌 Commit d9afca5 has been approved by jyn514,GuillaumeGomez
@borsbors
removed
the 
S-waiting-on-author
Status: This is awaiting some action (such as code changes or more information) from the author.
label
Nov 27, 2021
@borsbors
added
the 
S-waiting-on-bors
Status: Waiting on bors to run and complete tests. Bors will change the label on completion.
label
Nov 27, 2021
matthiaskrgr added a commit
to matthiaskrgr/rust
that referenced
this pull request
Nov 27, 2021
@matthiaskrgr
Rollup merge ofrust-lang#91062- jsha:static-file-replace, r=jyn514,…
bdcc293
…GuillaumeGomez
rustdoc: Consolidate static-file replacement mechanism
There were a few places in rustdoc where we would take static JS or CSS and rewrite it at doc generation time to insert values. This consolidates all the CSS instances into one CSS file and replaces the JS examples with data- attributes on the rustdoc-vars div.
Demo https://rustdoc.crud.net/jsha/static-file-replace/test_docs/
r? `@GuillaumeGomez`

This was referenced Nov 27, 2021
 Closed

 Merged

bors added a commit
to rust-lang-ci/rust
that referenced
this pull request
Nov 27, 2021
@bors
Auto merge ofrust-lang#91288- matthiaskrgr:rollup-yp5h41r, r=matthi…
686e313
…askrgr
Rollup of 6 pull requests
Successful merges:
- rust-lang#83791 (Weaken guarantee around advancing underlying iterators in zip)
- rust-lang#90995 (Document non-guarantees for Hash)
- rust-lang#91057 (Expand `available_parallelism` docs in anticipation of cgroup quota support)
- rust-lang#91062 (rustdoc: Consolidate static-file replacement mechanism)
- rust-lang#91208 (Account for incorrect `where T::Assoc = Ty` bound)
- rust-lang#91266 (Use non-generic inner function for pointer formatting)
Failed merges:
r? `@ghost`
`@rustbot` modify labels: rollup
@bors
bors
merged commit 55f8b5f
into
rust-lang:masterNov 27, 2021
@rustbotrustbot
added this to the 1.59.0 milestone
Nov 27, 2021
@camelidcamelid
mentioned this pull request
Nov 28, 2021

Closed

@jsha
jsha
deleted the

static-file-replace

branch
November 28, 2021 04:52
@Folyd
Folyd
commented
Dec 7, 2021

Copy link


Copy Markdown

Contributor
Ohhh, this PR broke my extension huhu/rust-search-extension#134. 😅
Rust search extension relies on the search-index.js. I hope we can keep the search-index.js loading steadily. Would you mind CC me if the search-index.js loading method has changed? Thanks. ❤️ @jsha@GuillaumeGomez
@jyn514
jyn514
commented
Dec 7, 2021

Copy link


Copy Markdown

Member
@Folyd you can set up an automatic ping in the highfive bot if you like - here's an example: https://github.com/rust-lang/highfive/blob/6e2c21639aaeafaeae423b244d353247c507d46a/highfive/configs/rust-lang/rust.json#L134
Folyd added a commit
to Folyd/highfive
that referenced
this pull request
Dec 7, 2021
@Folyd
Add new reviewer to librustdoc static files
747b4c4
Ping @Folyd if some changes occurred in librustdoc's HTML/CSS/JS.
Related context: rust-lang/rust#91062 (comment)
@FolydFolyd
mentioned this pull request
Dec 7, 2021
 Merged

@yvtyvt
mentioned this pull request
Aug 19, 2022

Open

@sypharsyphar
mentioned this pull request
Dec 28, 2022

Open

Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@GuillaumeGomezGuillaumeGomezGuillaumeGomez approved these changes

+1 more reviewer

@jyn514jyn514jyn514 approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

@GuillaumeGomezGuillaumeGomez

Labels

A-rustdoc-uiArea: Rustdoc UI (generated HTML)S-waiting-on-borsStatus: Waiting on bors to run and complete tests. Bors will change the label on completion.T-rustdocRelevant to the rustdoc team, which will review and decide on the PR/issue.

Projects


None yet


Milestone

1.59.0

Development

Successfully merging this pull request may close these issues.

8 participants

@jsha@rust-highfive@rust-log-analyzer@GuillaumeGomez@bors@Folyd@jyn514@rustbot

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
rustdoc: Consolidate static-file replacement mechanism - #91062
Merged
bors merged 3 commits into
rust-lang:masterfrom 
jsha:static-file-replace
Nov 27, 2021
Merged
rustdoc: Consolidate static-file replacement mechanism#91062
bors merged 3 commits into
rust-lang:masterfrom 
jsha:static-file-replace
Conversation
@jsha
@jshajsha
commented
Nov 19, 2021•

edited

Loading

Copy link


Copy Markdown

Contributor
There were a few places in rustdoc where we would take static JS or CSS and rewrite it at doc generation time to insert values. This consolidates all the CSS instances into one CSS file and replaces the JS examples with data- attributes on the rustdoc-vars div.
Demo https://rustdoc.crud.net/jsha/static-file-replace/test_docs/
r? @GuillaumeGomez
@jshajsha
added

T-rustdoc
Relevant to the rustdoc team, which will review and decide on the PR/issue.
A-rustdoc-ui
Area: Rustdoc UI (generated HTML)
labels
Nov 19, 2021
@rust-highfive
rust-highfive
commented
Nov 19, 2021

Copy link


Copy Markdown

Contributor
Some changes occurred in HTML/CSS/JS.
cc @GuillaumeGomez
@rust-highfiverust-highfive
added
the 
S-waiting-on-review
Status: Awaiting review from the assignee but also interested parties.
label
Nov 19, 2021
@rust-log-analyzer

This comment has been minimized.

Sign in to view
@jyn514jyn514
changed the title
Consolidate static-file replacement mechanismrustdoc: Consolidate static-file replacement mechanismNov 20, 2021
jyn514
jyn514
reviewed
Nov 20, 2021
View reviewed changes
Comment threadsrc/librustdoc/html/render/write_shared.rs
Outdated

@jyn514jyn514Nov 20, 2021

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You can remove this FIXME now I think :)
jyn514
jyn514
reviewed
Nov 20, 2021
View reviewed changes
Comment threadsrc/librustdoc/html/render/write_shared.rs
Outdated

@jyn514jyn514Nov 20, 2021

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm, I think this should be using cx.write_minify(InvocationSpecific), since it can vary from crate to crate. Unfortunately we don't have a good way of testing this before it hits nightly right now.
@jshajshaNov 20, 2021

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The only thing that is invocation specific is the list of themes, right? What if I put those in a data- attribute in the HTML instead? The list is quite short, so duplication is not a big concern.
@jyn514jyn514Nov 20, 2021

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That would be great! Thanks :)
GuillaumeGomez
GuillaumeGomez
reviewed
Nov 20, 2021
View reviewed changes
Comment threadsrc/librustdoc/html/static/js/storage.js
Outdated

@GuillaumeGomezGuillaumeGomezNov 20, 2021

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm a bit worried about this: if we generate docs with two different rustdoc version and/or different suffix, it means the older version will use newer files, which might break the display.
@jshajshaNov 21, 2021

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

storage is stored as a versioned file (e.g. storage1.58.0.js), so it would load the other versioned files that match it.
@GuillaumeGomezGuillaumeGomezNov 21, 2021

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That is, if you use suffix, otherwise you'll simply overwrite.
@jyn514jyn514Nov 21, 2021

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think it's possible for rustdoc alone to prevent conflicting versions with our current setup. If you think that should be a goal, maybe open an issue or MCP but I don't think it makes sense to hold specific parts of rustdoc to a higher standard than others.
@jshajshaNov 21, 2021

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The more I think about it, the more I think it would be cleaner to put each of these three variables in a data- attribute in the HTML, like I proposed in #91062 (comment). The big advantage there is that when you're editing JS you can copy it directly into place without waiting to rebuild rustdoc. I've run into this a number of times just recently.
@GuillaumeGomezGuillaumeGomezNov 21, 2021

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think it's possible for rustdoc alone to prevent conflicting versions with our current setup. If you think that should be a goal, maybe open an issue or MCP but I don't think it makes sense to hold specific parts of rustdoc to a higher standard than others.
It is working currently because the links are set directly in the HTML, not in the JS which is regenerated. This is my biggest issue with this change, moving "hard-coded" HTML content into JS.
@jsha Yes, I think that could work. The added size would be negligible as well.
@jsha
jshaforce-pushed
the
static-file-replace
branch
from
b424fd8 to
7a5cd2bCompareNovember 24, 2021 05:29
@jsha
jsha
commented
Nov 24, 2021

Copy link


Copy Markdown

ContributorAuthor
Alright, I switched this up so that main.js isn't rewritten at all - instead, the variables we want are set in the rustdoc-vars div.
One big change along the way: I revamped how stylesheets links are rendered into the HTML (c330963). I think this cleans things up a lot. It also made it much nicer to be able to generate a list of themes in layout.rs.
Also I changed storage.js to not rely on resource_suffix, because rustdoc-vars aren't yet available at the time storage.js runs.
@rust-log-analyzer

This comment has been minimized.

Sign in to view
@jsha
jshaforce-pushed
the
static-file-replace
branch
from
7a5cd2b to
276ea81CompareNovember 24, 2021 06:26
@rust-log-analyzer

This comment has been minimized.

Sign in to view
@jsha
jshaforce-pushed
the
static-file-replace
branch
from
276ea81 to
57e6fd7CompareNovember 24, 2021 07:47
@jshajsha
mentioned this pull request
Nov 24, 2021
 Merged

bors added a commit
to rust-lang-ci/rust
that referenced
this pull request
Nov 24, 2021
@bors
Auto merge ofrust-lang#91171- jsha:fix-rustdoc-gui-test, r=Guillaum…
982c552
…eGomez
Fix toggle-click-deadspace rustdoc-gui test
In rust-lang#91103 I introduced a rustdoc-gui test for clicks on toggles. I introduced some documentation on a method in lib2/struct.Foo.html so there would be something to toggle, but accidentally left the test checking test_docs/struct.Foo.html. That caused the test to reliably fail.
I'm not sure how that test got past GitHub Actions and bors, but it's manifesting in test failures at rust-lang#91062 (comment) and rust-lang#91170 (comment).
This fixes by pointing at the right file.
r? `@GuillaumeGomez`
jyn514
jyn514
approved these changes
Nov 24, 2021
View reviewed changes
@jyn514jyn514
left a comment


Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM but I want to give Guillaume a chance to review. Thanks for working on this :)
@GuillaumeGomez
GuillaumeGomez
commented
Nov 24, 2021

Copy link


Copy Markdown

Member
It looks good to me as well, thanks! You'll need to rebase to make the CI happy. ;)
r=jyn514,GuillaumeGomez once done.
@jyn514jyn514
added

S-waiting-on-author
Status: This is awaiting some action (such as code changes or more information) from the author.
and removed

S-waiting-on-review
Status: Awaiting review from the assignee but also interested parties.
labels
Nov 24, 2021
@jsha
Simplify rendering of stylesheet links into HTML
3649b90
We carry around a list of stylesheets that can carry two different types
of thing:
1. Internal stylesheets specific to a page type (only for settings)
2. Themes
In this change I move the link generation for settings.css into
settings(), so Context.style_files is reserved just for themes.
We had two places where we extracted a base theme name from a list of
StylePaths. I consolidated that code to be a method on StylePath.
I moved generation of link tags for stylesheets into the page.html
template. With that change, I made the template responsible for special
handling of light.css (making it the default theme) and of the other
themes (marking them disabled). That allowed getting rid of the
`disabled` field on StylePath.
@jsha
Move themes and version into rustdoc-vars
f0683f9
We had been injecting the list of themes and the rustdoc version into
main.js by rewriting it at doc generation time. By avoiding this
rewrite, we can make it easier to edit main.js without regenerating all
the docs.
Added a more convenient accessor for rustdoc-vars.
Changed storage.js to not rely on resourcesSuffix. It could in theory
use rustdoc-vars, but because rustdoc-vars is at the end of the HTML,
it's not available when storage.js runs (very early in page load).
@jsha
Consistentize the system for image URLs in CSS.
d9afca5
@jsha
jshaforce-pushed
the
static-file-replace
branch
from
57e6fd7 to
d9afca5CompareNovember 25, 2021 04:05
@jsha
jsha
commented
Nov 27, 2021

Copy link


Copy Markdown

ContributorAuthor
@bors r=jyn514,GuillaumeGomez
@bors
bors
commented
Nov 27, 2021

Copy link


Copy Markdown

Collaborator
📌 Commit d9afca5 has been approved by jyn514,GuillaumeGomez
@borsbors
removed
the 
S-waiting-on-author
Status: This is awaiting some action (such as code changes or more information) from the author.
label
Nov 27, 2021
@borsbors
added
the 
S-waiting-on-bors
Status: Waiting on bors to run and complete tests. Bors will change the label on completion.
label
Nov 27, 2021
matthiaskrgr added a commit
to matthiaskrgr/rust
that referenced
this pull request
Nov 27, 2021
@matthiaskrgr
Rollup merge ofrust-lang#91062- jsha:static-file-replace, r=jyn514,…
bdcc293
…GuillaumeGomez
rustdoc: Consolidate static-file replacement mechanism
There were a few places in rustdoc where we would take static JS or CSS and rewrite it at doc generation time to insert values. This consolidates all the CSS instances into one CSS file and replaces the JS examples with data- attributes on the rustdoc-vars div.
Demo https://rustdoc.crud.net/jsha/static-file-replace/test_docs/
r? `@GuillaumeGomez`

This was referenced Nov 27, 2021
 Closed

 Merged

bors added a commit
to rust-lang-ci/rust
that referenced
this pull request
Nov 27, 2021
@bors
Auto merge ofrust-lang#91288- matthiaskrgr:rollup-yp5h41r, r=matthi…
686e313
…askrgr
Rollup of 6 pull requests
Successful merges:
- rust-lang#83791 (Weaken guarantee around advancing underlying iterators in zip)
- rust-lang#90995 (Document non-guarantees for Hash)
- rust-lang#91057 (Expand `available_parallelism` docs in anticipation of cgroup quota support)
- rust-lang#91062 (rustdoc: Consolidate static-file replacement mechanism)
- rust-lang#91208 (Account for incorrect `where T::Assoc = Ty` bound)
- rust-lang#91266 (Use non-generic inner function for pointer formatting)
Failed merges:
r? `@ghost`
`@rustbot` modify labels: rollup
@bors
bors
merged commit 55f8b5f
into
rust-lang:masterNov 27, 2021
@rustbotrustbot
added this to the 1.59.0 milestone
Nov 27, 2021
@camelidcamelid
mentioned this pull request
Nov 28, 2021

Closed

@jsha
jsha
deleted the

static-file-replace

branch
November 28, 2021 04:52
@Folyd
Folyd
commented
Dec 7, 2021

Copy link


Copy Markdown

Contributor
Ohhh, this PR broke my extension huhu/rust-search-extension#134. 😅
Rust search extension relies on the search-index.js. I hope we can keep the search-index.js loading steadily. Would you mind CC me if the search-index.js loading method has changed? Thanks. ❤️ @jsha@GuillaumeGomez
@jyn514
jyn514
commented
Dec 7, 2021

Copy link


Copy Markdown

Member
@Folyd you can set up an automatic ping in the highfive bot if you like - here's an example: https://github.com/rust-lang/highfive/blob/6e2c21639aaeafaeae423b244d353247c507d46a/highfive/configs/rust-lang/rust.json#L134
Folyd added a commit
to Folyd/highfive
that referenced
this pull request
Dec 7, 2021
@Folyd
Add new reviewer to librustdoc static files
747b4c4
Ping @Folyd if some changes occurred in librustdoc's HTML/CSS/JS.
Related context: rust-lang/rust#91062 (comment)
@FolydFolyd
mentioned this pull request
Dec 7, 2021
 Merged

@yvtyvt
mentioned this pull request
Aug 19, 2022

Open

@sypharsyphar
mentioned this pull request
Dec 28, 2022

Open

Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@GuillaumeGomezGuillaumeGomezGuillaumeGomez approved these changes

+1 more reviewer

@jyn514jyn514jyn514 approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

@GuillaumeGomezGuillaumeGomez

Labels

A-rustdoc-uiArea: Rustdoc UI (generated HTML)S-waiting-on-borsStatus: Waiting on bors to run and complete tests. Bors will change the label on completion.T-rustdocRelevant to the rustdoc team, which will review and decide on the PR/issue.

Projects


None yet


Milestone

1.59.0

Development

Successfully merging this pull request may close these issues.

8 participants

@jsha@rust-highfive@rust-log-analyzer@GuillaumeGomez@bors@Folyd@jyn514@rustbot

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
rustdoc: Consolidate static-file replacement mechanism - #91062
Merged
bors merged 3 commits into
rust-lang:masterfrom 
jsha:static-file-replace
Nov 27, 2021
Merged
rustdoc: Consolidate static-file replacement mechanism#91062
bors merged 3 commits into
rust-lang:masterfrom 
jsha:static-file-replace
Conversation
@jsha
@jshajsha
commented
Nov 19, 2021•

edited

Loading

Copy link


Copy Markdown

Contributor
There were a few places in rustdoc where we would take static JS or CSS and rewrite it at doc generation time to insert values. This consolidates all the CSS instances into one CSS file and replaces the JS examples with data- attributes on the rustdoc-vars div.
Demo https://rustdoc.crud.net/jsha/static-file-replace/test_docs/
r? @GuillaumeGomez
@jshajsha
added

T-rustdoc
Relevant to the rustdoc team, which will review and decide on the PR/issue.
A-rustdoc-ui
Area: Rustdoc UI (generated HTML)
labels
Nov 19, 2021
@rust-highfive
rust-highfive
commented
Nov 19, 2021

Copy link


Copy Markdown

Contributor
Some changes occurred in HTML/CSS/JS.
cc @GuillaumeGomez
@rust-highfiverust-highfive
added
the 
S-waiting-on-review
Status: Awaiting review from the assignee but also interested parties.
label
Nov 19, 2021
@rust-log-analyzer

This comment has been minimized.

Sign in to view
@jyn514jyn514
changed the title
Consolidate static-file replacement mechanismrustdoc: Consolidate static-file replacement mechanismNov 20, 2021
jyn514
jyn514
reviewed
Nov 20, 2021
View reviewed changes
Comment threadsrc/librustdoc/html/render/write_shared.rs
Outdated

@jyn514jyn514Nov 20, 2021

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You can remove this FIXME now I think :)
jyn514
jyn514
reviewed
Nov 20, 2021
View reviewed changes
Comment threadsrc/librustdoc/html/render/write_shared.rs
Outdated

@jyn514jyn514Nov 20, 2021

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm, I think this should be using cx.write_minify(InvocationSpecific), since it can vary from crate to crate. Unfortunately we don't have a good way of testing this before it hits nightly right now.
@jshajshaNov 20, 2021

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The only thing that is invocation specific is the list of themes, right? What if I put those in a data- attribute in the HTML instead? The list is quite short, so duplication is not a big concern.
@jyn514jyn514Nov 20, 2021

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That would be great! Thanks :)
GuillaumeGomez
GuillaumeGomez
reviewed
Nov 20, 2021
View reviewed changes
Comment threadsrc/librustdoc/html/static/js/storage.js
Outdated

@GuillaumeGomezGuillaumeGomezNov 20, 2021

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm a bit worried about this: if we generate docs with two different rustdoc version and/or different suffix, it means the older version will use newer files, which might break the display.
@jshajshaNov 21, 2021

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

storage is stored as a versioned file (e.g. storage1.58.0.js), so it would load the other versioned files that match it.
@GuillaumeGomezGuillaumeGomezNov 21, 2021

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That is, if you use suffix, otherwise you'll simply overwrite.
@jyn514jyn514Nov 21, 2021

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think it's possible for rustdoc alone to prevent conflicting versions with our current setup. If you think that should be a goal, maybe open an issue or MCP but I don't think it makes sense to hold specific parts of rustdoc to a higher standard than others.
@jshajshaNov 21, 2021

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The more I think about it, the more I think it would be cleaner to put each of these three variables in a data- attribute in the HTML, like I proposed in #91062 (comment). The big advantage there is that when you're editing JS you can copy it directly into place without waiting to rebuild rustdoc. I've run into this a number of times just recently.
@GuillaumeGomezGuillaumeGomezNov 21, 2021

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think it's possible for rustdoc alone to prevent conflicting versions with our current setup. If you think that should be a goal, maybe open an issue or MCP but I don't think it makes sense to hold specific parts of rustdoc to a higher standard than others.
It is working currently because the links are set directly in the HTML, not in the JS which is regenerated. This is my biggest issue with this change, moving "hard-coded" HTML content into JS.
@jsha Yes, I think that could work. The added size would be negligible as well.
@jsha
jshaforce-pushed
the
static-file-replace
branch
from
b424fd8 to
7a5cd2bCompareNovember 24, 2021 05:29
@jsha
jsha
commented
Nov 24, 2021

Copy link


Copy Markdown

ContributorAuthor
Alright, I switched this up so that main.js isn't rewritten at all - instead, the variables we want are set in the rustdoc-vars div.
One big change along the way: I revamped how stylesheets links are rendered into the HTML (c330963). I think this cleans things up a lot. It also made it much nicer to be able to generate a list of themes in layout.rs.
Also I changed storage.js to not rely on resource_suffix, because rustdoc-vars aren't yet available at the time storage.js runs.
@rust-log-analyzer

This comment has been minimized.

Sign in to view
@jsha
jshaforce-pushed
the
static-file-replace
branch
from
7a5cd2b to
276ea81CompareNovember 24, 2021 06:26
@rust-log-analyzer

This comment has been minimized.

Sign in to view
@jsha
jshaforce-pushed
the
static-file-replace
branch
from
276ea81 to
57e6fd7CompareNovember 24, 2021 07:47
@jshajsha
mentioned this pull request
Nov 24, 2021
 Merged

bors added a commit
to rust-lang-ci/rust
that referenced
this pull request
Nov 24, 2021
@bors
Auto merge ofrust-lang#91171- jsha:fix-rustdoc-gui-test, r=Guillaum…
982c552
…eGomez
Fix toggle-click-deadspace rustdoc-gui test
In rust-lang#91103 I introduced a rustdoc-gui test for clicks on toggles. I introduced some documentation on a method in lib2/struct.Foo.html so there would be something to toggle, but accidentally left the test checking test_docs/struct.Foo.html. That caused the test to reliably fail.
I'm not sure how that test got past GitHub Actions and bors, but it's manifesting in test failures at rust-lang#91062 (comment) and rust-lang#91170 (comment).
This fixes by pointing at the right file.
r? `@GuillaumeGomez`
jyn514
jyn514
approved these changes
Nov 24, 2021
View reviewed changes
@jyn514jyn514
left a comment


Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM but I want to give Guillaume a chance to review. Thanks for working on this :)
@GuillaumeGomez
GuillaumeGomez
commented
Nov 24, 2021

Copy link


Copy Markdown

Member
It looks good to me as well, thanks! You'll need to rebase to make the CI happy. ;)
r=jyn514,GuillaumeGomez once done.
@jyn514jyn514
added

S-waiting-on-author
Status: This is awaiting some action (such as code changes or more information) from the author.
and removed

S-waiting-on-review
Status: Awaiting review from the assignee but also interested parties.
labels
Nov 24, 2021
@jsha
Simplify rendering of stylesheet links into HTML
3649b90
We carry around a list of stylesheets that can carry two different types
of thing:
1. Internal stylesheets specific to a page type (only for settings)
2. Themes
In this change I move the link generation for settings.css into
settings(), so Context.style_files is reserved just for themes.
We had two places where we extracted a base theme name from a list of
StylePaths. I consolidated that code to be a method on StylePath.
I moved generation of link tags for stylesheets into the page.html
template. With that change, I made the template responsible for special
handling of light.css (making it the default theme) and of the other
themes (marking them disabled). That allowed getting rid of the
`disabled` field on StylePath.
@jsha
Move themes and version into rustdoc-vars
f0683f9
We had been injecting the list of themes and the rustdoc version into
main.js by rewriting it at doc generation time. By avoiding this
rewrite, we can make it easier to edit main.js without regenerating all
the docs.
Added a more convenient accessor for rustdoc-vars.
Changed storage.js to not rely on resourcesSuffix. It could in theory
use rustdoc-vars, but because rustdoc-vars is at the end of the HTML,
it's not available when storage.js runs (very early in page load).
@jsha
Consistentize the system for image URLs in CSS.
d9afca5
@jsha
jshaforce-pushed
the
static-file-replace
branch
from
57e6fd7 to
d9afca5CompareNovember 25, 2021 04:05
@jsha
jsha
commented
Nov 27, 2021

Copy link


Copy Markdown

ContributorAuthor
@bors r=jyn514,GuillaumeGomez
@bors
bors
commented
Nov 27, 2021

Copy link


Copy Markdown

Collaborator
📌 Commit d9afca5 has been approved by jyn514,GuillaumeGomez
@borsbors
removed
the 
S-waiting-on-author
Status: This is awaiting some action (such as code changes or more information) from the author.
label
Nov 27, 2021
@borsbors
added
the 
S-waiting-on-bors
Status: Waiting on bors to run and complete tests. Bors will change the label on completion.
label
Nov 27, 2021
matthiaskrgr added a commit
to matthiaskrgr/rust
that referenced
this pull request
Nov 27, 2021
@matthiaskrgr
Rollup merge ofrust-lang#91062- jsha:static-file-replace, r=jyn514,…
bdcc293
…GuillaumeGomez
rustdoc: Consolidate static-file replacement mechanism
There were a few places in rustdoc where we would take static JS or CSS and rewrite it at doc generation time to insert values. This consolidates all the CSS instances into one CSS file and replaces the JS examples with data- attributes on the rustdoc-vars div.
Demo https://rustdoc.crud.net/jsha/static-file-replace/test_docs/
r? `@GuillaumeGomez`

This was referenced Nov 27, 2021
 Closed

 Merged

bors added a commit
to rust-lang-ci/rust
that referenced
this pull request
Nov 27, 2021
@bors
Auto merge ofrust-lang#91288- matthiaskrgr:rollup-yp5h41r, r=matthi…
686e313
…askrgr
Rollup of 6 pull requests
Successful merges:
- rust-lang#83791 (Weaken guarantee around advancing underlying iterators in zip)
- rust-lang#90995 (Document non-guarantees for Hash)
- rust-lang#91057 (Expand `available_parallelism` docs in anticipation of cgroup quota support)
- rust-lang#91062 (rustdoc: Consolidate static-file replacement mechanism)
- rust-lang#91208 (Account for incorrect `where T::Assoc = Ty` bound)
- rust-lang#91266 (Use non-generic inner function for pointer formatting)
Failed merges:
r? `@ghost`
`@rustbot` modify labels: rollup
@bors
bors
merged commit 55f8b5f
into
rust-lang:masterNov 27, 2021
@rustbotrustbot
added this to the 1.59.0 milestone
Nov 27, 2021
@camelidcamelid
mentioned this pull request
Nov 28, 2021

Closed

@jsha
jsha
deleted the

static-file-replace

branch
November 28, 2021 04:52
@Folyd
Folyd
commented
Dec 7, 2021

Copy link


Copy Markdown

Contributor
Ohhh, this PR broke my extension huhu/rust-search-extension#134. 😅
Rust search extension relies on the search-index.js. I hope we can keep the search-index.js loading steadily. Would you mind CC me if the search-index.js loading method has changed? Thanks. ❤️ @jsha@GuillaumeGomez
@jyn514
jyn514
commented
Dec 7, 2021

Copy link


Copy Markdown

Member
@Folyd you can set up an automatic ping in the highfive bot if you like - here's an example: https://github.com/rust-lang/highfive/blob/6e2c21639aaeafaeae423b244d353247c507d46a/highfive/configs/rust-lang/rust.json#L134
Folyd added a commit
to Folyd/highfive
that referenced
this pull request
Dec 7, 2021
@Folyd
Add new reviewer to librustdoc static files
747b4c4
Ping @Folyd if some changes occurred in librustdoc's HTML/CSS/JS.
Related context: rust-lang/rust#91062 (comment)
@FolydFolyd
mentioned this pull request
Dec 7, 2021
 Merged

@yvtyvt
mentioned this pull request
Aug 19, 2022

Open

@sypharsyphar
mentioned this pull request
Dec 28, 2022

Open

Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@GuillaumeGomezGuillaumeGomezGuillaumeGomez approved these changes

+1 more reviewer

@jyn514jyn514jyn514 approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

@GuillaumeGomezGuillaumeGomez

Labels

A-rustdoc-uiArea: Rustdoc UI (generated HTML)S-waiting-on-borsStatus: Waiting on bors to run and complete tests. Bors will change the label on completion.T-rustdocRelevant to the rustdoc team, which will review and decide on the PR/issue.

Projects


None yet


Milestone

1.59.0

Development

Successfully merging this pull request may close these issues.

8 participants

@jsha@rust-highfive@rust-log-analyzer@GuillaumeGomez@bors@Folyd@jyn514@rustbot

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
rustdoc: Consolidate static-file replacement mechanism - #91062
Merged
bors merged 3 commits into
rust-lang:masterfrom 
jsha:static-file-replace
Nov 27, 2021
Merged
rustdoc: Consolidate static-file replacement mechanism#91062
bors merged 3 commits into
rust-lang:masterfrom 
jsha:static-file-replace
Conversation
@jsha
@jshajsha
commented
Nov 19, 2021•

edited

Loading

Copy link


Copy Markdown

Contributor
There were a few places in rustdoc where we would take static JS or CSS and rewrite it at doc generation time to insert values. This consolidates all the CSS instances into one CSS file and replaces the JS examples with data- attributes on the rustdoc-vars div.
Demo https://rustdoc.crud.net/jsha/static-file-replace/test_docs/
r? @GuillaumeGomez
@jshajsha
added

T-rustdoc
Relevant to the rustdoc team, which will review and decide on the PR/issue.
A-rustdoc-ui
Area: Rustdoc UI (generated HTML)
labels
Nov 19, 2021
@rust-highfive
rust-highfive
commented
Nov 19, 2021

Copy link


Copy Markdown

Contributor
Some changes occurred in HTML/CSS/JS.
cc @GuillaumeGomez
@rust-highfiverust-highfive
added
the 
S-waiting-on-review
Status: Awaiting review from the assignee but also interested parties.
label
Nov 19, 2021
@rust-log-analyzer

This comment has been minimized.

Sign in to view
@jyn514jyn514
changed the title
Consolidate static-file replacement mechanismrustdoc: Consolidate static-file replacement mechanismNov 20, 2021
jyn514
jyn514
reviewed
Nov 20, 2021
View reviewed changes
Comment threadsrc/librustdoc/html/render/write_shared.rs
Outdated

@jyn514jyn514Nov 20, 2021

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You can remove this FIXME now I think :)
jyn514
jyn514
reviewed
Nov 20, 2021
View reviewed changes
Comment threadsrc/librustdoc/html/render/write_shared.rs
Outdated

@jyn514jyn514Nov 20, 2021

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm, I think this should be using cx.write_minify(InvocationSpecific), since it can vary from crate to crate. Unfortunately we don't have a good way of testing this before it hits nightly right now.
@jshajshaNov 20, 2021

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The only thing that is invocation specific is the list of themes, right? What if I put those in a data- attribute in the HTML instead? The list is quite short, so duplication is not a big concern.
@jyn514jyn514Nov 20, 2021

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That would be great! Thanks :)
GuillaumeGomez
GuillaumeGomez
reviewed
Nov 20, 2021
View reviewed changes
Comment threadsrc/librustdoc/html/static/js/storage.js
Outdated

@GuillaumeGomezGuillaumeGomezNov 20, 2021

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm a bit worried about this: if we generate docs with two different rustdoc version and/or different suffix, it means the older version will use newer files, which might break the display.
@jshajshaNov 21, 2021

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

storage is stored as a versioned file (e.g. storage1.58.0.js), so it would load the other versioned files that match it.
@GuillaumeGomezGuillaumeGomezNov 21, 2021

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That is, if you use suffix, otherwise you'll simply overwrite.
@jyn514jyn514Nov 21, 2021

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think it's possible for rustdoc alone to prevent conflicting versions with our current setup. If you think that should be a goal, maybe open an issue or MCP but I don't think it makes sense to hold specific parts of rustdoc to a higher standard than others.
@jshajshaNov 21, 2021

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The more I think about it, the more I think it would be cleaner to put each of these three variables in a data- attribute in the HTML, like I proposed in #91062 (comment). The big advantage there is that when you're editing JS you can copy it directly into place without waiting to rebuild rustdoc. I've run into this a number of times just recently.
@GuillaumeGomezGuillaumeGomezNov 21, 2021

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think it's possible for rustdoc alone to prevent conflicting versions with our current setup. If you think that should be a goal, maybe open an issue or MCP but I don't think it makes sense to hold specific parts of rustdoc to a higher standard than others.
It is working currently because the links are set directly in the HTML, not in the JS which is regenerated. This is my biggest issue with this change, moving "hard-coded" HTML content into JS.
@jsha Yes, I think that could work. The added size would be negligible as well.
@jsha
jshaforce-pushed
the
static-file-replace
branch
from
b424fd8 to
7a5cd2bCompareNovember 24, 2021 05:29
@jsha
jsha
commented
Nov 24, 2021

Copy link


Copy Markdown

ContributorAuthor
Alright, I switched this up so that main.js isn't rewritten at all - instead, the variables we want are set in the rustdoc-vars div.
One big change along the way: I revamped how stylesheets links are rendered into the HTML (c330963). I think this cleans things up a lot. It also made it much nicer to be able to generate a list of themes in layout.rs.
Also I changed storage.js to not rely on resource_suffix, because rustdoc-vars aren't yet available at the time storage.js runs.
@rust-log-analyzer

This comment has been minimized.

Sign in to view
@jsha
jshaforce-pushed
the
static-file-replace
branch
from
7a5cd2b to
276ea81CompareNovember 24, 2021 06:26
@rust-log-analyzer

This comment has been minimized.

Sign in to view
@jsha
jshaforce-pushed
the
static-file-replace
branch
from
276ea81 to
57e6fd7CompareNovember 24, 2021 07:47
@jshajsha
mentioned this pull request
Nov 24, 2021
 Merged

bors added a commit
to rust-lang-ci/rust
that referenced
this pull request
Nov 24, 2021
@bors
Auto merge ofrust-lang#91171- jsha:fix-rustdoc-gui-test, r=Guillaum…
982c552
…eGomez
Fix toggle-click-deadspace rustdoc-gui test
In rust-lang#91103 I introduced a rustdoc-gui test for clicks on toggles. I introduced some documentation on a method in lib2/struct.Foo.html so there would be something to toggle, but accidentally left the test checking test_docs/struct.Foo.html. That caused the test to reliably fail.
I'm not sure how that test got past GitHub Actions and bors, but it's manifesting in test failures at rust-lang#91062 (comment) and rust-lang#91170 (comment).
This fixes by pointing at the right file.
r? `@GuillaumeGomez`
jyn514
jyn514
approved these changes
Nov 24, 2021
View reviewed changes
@jyn514jyn514
left a comment


Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM but I want to give Guillaume a chance to review. Thanks for working on this :)
@GuillaumeGomez
GuillaumeGomez
commented
Nov 24, 2021

Copy link


Copy Markdown

Member
It looks good to me as well, thanks! You'll need to rebase to make the CI happy. ;)
r=jyn514,GuillaumeGomez once done.
@jyn514jyn514
added

S-waiting-on-author
Status: This is awaiting some action (such as code changes or more information) from the author.
and removed

S-waiting-on-review
Status: Awaiting review from the assignee but also interested parties.
labels
Nov 24, 2021
@jsha
Simplify rendering of stylesheet links into HTML
3649b90
We carry around a list of stylesheets that can carry two different types
of thing:
1. Internal stylesheets specific to a page type (only for settings)
2. Themes
In this change I move the link generation for settings.css into
settings(), so Context.style_files is reserved just for themes.
We had two places where we extracted a base theme name from a list of
StylePaths. I consolidated that code to be a method on StylePath.
I moved generation of link tags for stylesheets into the page.html
template. With that change, I made the template responsible for special
handling of light.css (making it the default theme) and of the other
themes (marking them disabled). That allowed getting rid of the
`disabled` field on StylePath.
@jsha
Move themes and version into rustdoc-vars
f0683f9
We had been injecting the list of themes and the rustdoc version into
main.js by rewriting it at doc generation time. By avoiding this
rewrite, we can make it easier to edit main.js without regenerating all
the docs.
Added a more convenient accessor for rustdoc-vars.
Changed storage.js to not rely on resourcesSuffix. It could in theory
use rustdoc-vars, but because rustdoc-vars is at the end of the HTML,
it's not available when storage.js runs (very early in page load).
@jsha
Consistentize the system for image URLs in CSS.
d9afca5
@jsha
jshaforce-pushed
the
static-file-replace
branch
from
57e6fd7 to
d9afca5CompareNovember 25, 2021 04:05
@jsha
jsha
commented
Nov 27, 2021

Copy link


Copy Markdown

ContributorAuthor
@bors r=jyn514,GuillaumeGomez
@bors
bors
commented
Nov 27, 2021

Copy link


Copy Markdown

Collaborator
📌 Commit d9afca5 has been approved by jyn514,GuillaumeGomez
@borsbors
removed
the 
S-waiting-on-author
Status: This is awaiting some action (such as code changes or more information) from the author.
label
Nov 27, 2021
@borsbors
added
the 
S-waiting-on-bors
Status: Waiting on bors to run and complete tests. Bors will change the label on completion.
label
Nov 27, 2021
matthiaskrgr added a commit
to matthiaskrgr/rust
that referenced
this pull request
Nov 27, 2021
@matthiaskrgr
Rollup merge ofrust-lang#91062- jsha:static-file-replace, r=jyn514,…
bdcc293
…GuillaumeGomez
rustdoc: Consolidate static-file replacement mechanism
There were a few places in rustdoc where we would take static JS or CSS and rewrite it at doc generation time to insert values. This consolidates all the CSS instances into one CSS file and replaces the JS examples with data- attributes on the rustdoc-vars div.
Demo https://rustdoc.crud.net/jsha/static-file-replace/test_docs/
r? `@GuillaumeGomez`

This was referenced Nov 27, 2021
 Closed

 Merged

bors added a commit
to rust-lang-ci/rust
that referenced
this pull request
Nov 27, 2021
@bors
Auto merge ofrust-lang#91288- matthiaskrgr:rollup-yp5h41r, r=matthi…
686e313
…askrgr
Rollup of 6 pull requests
Successful merges:
- rust-lang#83791 (Weaken guarantee around advancing underlying iterators in zip)
- rust-lang#90995 (Document non-guarantees for Hash)
- rust-lang#91057 (Expand `available_parallelism` docs in anticipation of cgroup quota support)
- rust-lang#91062 (rustdoc: Consolidate static-file replacement mechanism)
- rust-lang#91208 (Account for incorrect `where T::Assoc = Ty` bound)
- rust-lang#91266 (Use non-generic inner function for pointer formatting)
Failed merges:
r? `@ghost`
`@rustbot` modify labels: rollup
@bors
bors
merged commit 55f8b5f
into
rust-lang:masterNov 27, 2021
@rustbotrustbot
added this to the 1.59.0 milestone
Nov 27, 2021
@camelidcamelid
mentioned this pull request
Nov 28, 2021

Closed

@jsha
jsha
deleted the

static-file-replace

branch
November 28, 2021 04:52
@Folyd
Folyd
commented
Dec 7, 2021

Copy link


Copy Markdown

Contributor
Ohhh, this PR broke my extension huhu/rust-search-extension#134. 😅
Rust search extension relies on the search-index.js. I hope we can keep the search-index.js loading steadily. Would you mind CC me if the search-index.js loading method has changed? Thanks. ❤️ @jsha@GuillaumeGomez
@jyn514
jyn514
commented
Dec 7, 2021

Copy link


Copy Markdown

Member
@Folyd you can set up an automatic ping in the highfive bot if you like - here's an example: https://github.com/rust-lang/highfive/blob/6e2c21639aaeafaeae423b244d353247c507d46a/highfive/configs/rust-lang/rust.json#L134
Folyd added a commit
to Folyd/highfive
that referenced
this pull request
Dec 7, 2021
@Folyd
Add new reviewer to librustdoc static files
747b4c4
Ping @Folyd if some changes occurred in librustdoc's HTML/CSS/JS.
Related context: rust-lang/rust#91062 (comment)
@FolydFolyd
mentioned this pull request
Dec 7, 2021
 Merged

@yvtyvt
mentioned this pull request
Aug 19, 2022

Open

@sypharsyphar
mentioned this pull request
Dec 28, 2022

Open

Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@GuillaumeGomezGuillaumeGomezGuillaumeGomez approved these changes

+1 more reviewer

@jyn514jyn514jyn514 approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

@GuillaumeGomezGuillaumeGomez

Labels

A-rustdoc-uiArea: Rustdoc UI (generated HTML)S-waiting-on-borsStatus: Waiting on bors to run and complete tests. Bors will change the label on completion.T-rustdocRelevant to the rustdoc team, which will review and decide on the PR/issue.

Projects


None yet


Milestone

1.59.0

Development

Successfully merging this pull request may close these issues.

8 participants

@jsha@rust-highfive@rust-log-analyzer@GuillaumeGomez@bors@Folyd@jyn514@rustbot

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
rustdoc: Consolidate static-file replacement mechanism - #91062
Merged
bors merged 3 commits into
rust-lang:masterfrom 
jsha:static-file-replace
Nov 27, 2021
Merged
rustdoc: Consolidate static-file replacement mechanism#91062
bors merged 3 commits into
rust-lang:masterfrom 
jsha:static-file-replace
Conversation
@jsha
@jshajsha
commented
Nov 19, 2021•

edited

Loading

Copy link


Copy Markdown

Contributor
There were a few places in rustdoc where we would take static JS or CSS and rewrite it at doc generation time to insert values. This consolidates all the CSS instances into one CSS file and replaces the JS examples with data- attributes on the rustdoc-vars div.
Demo https://rustdoc.crud.net/jsha/static-file-replace/test_docs/
r? @GuillaumeGomez
@jshajsha
added

T-rustdoc
Relevant to the rustdoc team, which will review and decide on the PR/issue.
A-rustdoc-ui
Area: Rustdoc UI (generated HTML)
labels
Nov 19, 2021
@rust-highfive
rust-highfive
commented
Nov 19, 2021

Copy link


Copy Markdown

Contributor
Some changes occurred in HTML/CSS/JS.
cc @GuillaumeGomez
@rust-highfiverust-highfive
added
the 
S-waiting-on-review
Status: Awaiting review from the assignee but also interested parties.
label
Nov 19, 2021
@rust-log-analyzer

This comment has been minimized.

Sign in to view
@jyn514jyn514
changed the title
Consolidate static-file replacement mechanismrustdoc: Consolidate static-file replacement mechanismNov 20, 2021
jyn514
jyn514
reviewed
Nov 20, 2021
View reviewed changes
Comment threadsrc/librustdoc/html/render/write_shared.rs
Outdated

@jyn514jyn514Nov 20, 2021

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You can remove this FIXME now I think :)
jyn514
jyn514
reviewed
Nov 20, 2021
View reviewed changes
Comment threadsrc/librustdoc/html/render/write_shared.rs
Outdated

@jyn514jyn514Nov 20, 2021

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm, I think this should be using cx.write_minify(InvocationSpecific), since it can vary from crate to crate. Unfortunately we don't have a good way of testing this before it hits nightly right now.
@jshajshaNov 20, 2021

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The only thing that is invocation specific is the list of themes, right? What if I put those in a data- attribute in the HTML instead? The list is quite short, so duplication is not a big concern.
@jyn514jyn514Nov 20, 2021

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That would be great! Thanks :)
GuillaumeGomez
GuillaumeGomez
reviewed
Nov 20, 2021
View reviewed changes
Comment threadsrc/librustdoc/html/static/js/storage.js
Outdated

@GuillaumeGomezGuillaumeGomezNov 20, 2021

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm a bit worried about this: if we generate docs with two different rustdoc version and/or different suffix, it means the older version will use newer files, which might break the display.
@jshajshaNov 21, 2021

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

storage is stored as a versioned file (e.g. storage1.58.0.js), so it would load the other versioned files that match it.
@GuillaumeGomezGuillaumeGomezNov 21, 2021

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That is, if you use suffix, otherwise you'll simply overwrite.
@jyn514jyn514Nov 21, 2021

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think it's possible for rustdoc alone to prevent conflicting versions with our current setup. If you think that should be a goal, maybe open an issue or MCP but I don't think it makes sense to hold specific parts of rustdoc to a higher standard than others.
@jshajshaNov 21, 2021

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The more I think about it, the more I think it would be cleaner to put each of these three variables in a data- attribute in the HTML, like I proposed in #91062 (comment). The big advantage there is that when you're editing JS you can copy it directly into place without waiting to rebuild rustdoc. I've run into this a number of times just recently.
@GuillaumeGomezGuillaumeGomezNov 21, 2021

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think it's possible for rustdoc alone to prevent conflicting versions with our current setup. If you think that should be a goal, maybe open an issue or MCP but I don't think it makes sense to hold specific parts of rustdoc to a higher standard than others.
It is working currently because the links are set directly in the HTML, not in the JS which is regenerated. This is my biggest issue with this change, moving "hard-coded" HTML content into JS.
@jsha Yes, I think that could work. The added size would be negligible as well.
@jsha
jshaforce-pushed
the
static-file-replace
branch
from
b424fd8 to
7a5cd2bCompareNovember 24, 2021 05:29
@jsha
jsha
commented
Nov 24, 2021

Copy link


Copy Markdown

ContributorAuthor
Alright, I switched this up so that main.js isn't rewritten at all - instead, the variables we want are set in the rustdoc-vars div.
One big change along the way: I revamped how stylesheets links are rendered into the HTML (c330963). I think this cleans things up a lot. It also made it much nicer to be able to generate a list of themes in layout.rs.
Also I changed storage.js to not rely on resource_suffix, because rustdoc-vars aren't yet available at the time storage.js runs.
@rust-log-analyzer

This comment has been minimized.

Sign in to view
@jsha
jshaforce-pushed
the
static-file-replace
branch
from
7a5cd2b to
276ea81CompareNovember 24, 2021 06:26
@rust-log-analyzer

This comment has been minimized.

Sign in to view
@jsha
jshaforce-pushed
the
static-file-replace
branch
from
276ea81 to
57e6fd7CompareNovember 24, 2021 07:47
@jshajsha
mentioned this pull request
Nov 24, 2021
 Merged

bors added a commit
to rust-lang-ci/rust
that referenced
this pull request
Nov 24, 2021
@bors
Auto merge ofrust-lang#91171- jsha:fix-rustdoc-gui-test, r=Guillaum…
982c552
…eGomez
Fix toggle-click-deadspace rustdoc-gui test
In rust-lang#91103 I introduced a rustdoc-gui test for clicks on toggles. I introduced some documentation on a method in lib2/struct.Foo.html so there would be something to toggle, but accidentally left the test checking test_docs/struct.Foo.html. That caused the test to reliably fail.
I'm not sure how that test got past GitHub Actions and bors, but it's manifesting in test failures at rust-lang#91062 (comment) and rust-lang#91170 (comment).
This fixes by pointing at the right file.
r? `@GuillaumeGomez`
jyn514
jyn514
approved these changes
Nov 24, 2021
View reviewed changes
@jyn514jyn514
left a comment


Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM but I want to give Guillaume a chance to review. Thanks for working on this :)
@GuillaumeGomez
GuillaumeGomez
commented
Nov 24, 2021

Copy link


Copy Markdown

Member
It looks good to me as well, thanks! You'll need to rebase to make the CI happy. ;)
r=jyn514,GuillaumeGomez once done.
@jyn514jyn514
added

S-waiting-on-author
Status: This is awaiting some action (such as code changes or more information) from the author.
and removed

S-waiting-on-review
Status: Awaiting review from the assignee but also interested parties.
labels
Nov 24, 2021
@jsha
Simplify rendering of stylesheet links into HTML
3649b90
We carry around a list of stylesheets that can carry two different types
of thing:
1. Internal stylesheets specific to a page type (only for settings)
2. Themes
In this change I move the link generation for settings.css into
settings(), so Context.style_files is reserved just for themes.
We had two places where we extracted a base theme name from a list of
StylePaths. I consolidated that code to be a method on StylePath.
I moved generation of link tags for stylesheets into the page.html
template. With that change, I made the template responsible for special
handling of light.css (making it the default theme) and of the other
themes (marking them disabled). That allowed getting rid of the
`disabled` field on StylePath.
@jsha
Move themes and version into rustdoc-vars
f0683f9
We had been injecting the list of themes and the rustdoc version into
main.js by rewriting it at doc generation time. By avoiding this
rewrite, we can make it easier to edit main.js without regenerating all
the docs.
Added a more convenient accessor for rustdoc-vars.
Changed storage.js to not rely on resourcesSuffix. It could in theory
use rustdoc-vars, but because rustdoc-vars is at the end of the HTML,
it's not available when storage.js runs (very early in page load).
@jsha
Consistentize the system for image URLs in CSS.
d9afca5
@jsha
jshaforce-pushed
the
static-file-replace
branch
from
57e6fd7 to
d9afca5CompareNovember 25, 2021 04:05
@jsha
jsha
commented
Nov 27, 2021

Copy link


Copy Markdown

ContributorAuthor
@bors r=jyn514,GuillaumeGomez
@bors
bors
commented
Nov 27, 2021

Copy link


Copy Markdown

Collaborator
📌 Commit d9afca5 has been approved by jyn514,GuillaumeGomez
@borsbors
removed
the 
S-waiting-on-author
Status: This is awaiting some action (such as code changes or more information) from the author.
label
Nov 27, 2021
@borsbors
added
the 
S-waiting-on-bors
Status: Waiting on bors to run and complete tests. Bors will change the label on completion.
label
Nov 27, 2021
matthiaskrgr added a commit
to matthiaskrgr/rust
that referenced
this pull request
Nov 27, 2021
@matthiaskrgr
Rollup merge ofrust-lang#91062- jsha:static-file-replace, r=jyn514,…
bdcc293
…GuillaumeGomez
rustdoc: Consolidate static-file replacement mechanism
There were a few places in rustdoc where we would take static JS or CSS and rewrite it at doc generation time to insert values. This consolidates all the CSS instances into one CSS file and replaces the JS examples with data- attributes on the rustdoc-vars div.
Demo https://rustdoc.crud.net/jsha/static-file-replace/test_docs/
r? `@GuillaumeGomez`

This was referenced Nov 27, 2021
 Closed

 Merged

bors added a commit
to rust-lang-ci/rust
that referenced
this pull request
Nov 27, 2021
@bors
Auto merge ofrust-lang#91288- matthiaskrgr:rollup-yp5h41r, r=matthi…
686e313
…askrgr
Rollup of 6 pull requests
Successful merges:
- rust-lang#83791 (Weaken guarantee around advancing underlying iterators in zip)
- rust-lang#90995 (Document non-guarantees for Hash)
- rust-lang#91057 (Expand `available_parallelism` docs in anticipation of cgroup quota support)
- rust-lang#91062 (rustdoc: Consolidate static-file replacement mechanism)
- rust-lang#91208 (Account for incorrect `where T::Assoc = Ty` bound)
- rust-lang#91266 (Use non-generic inner function for pointer formatting)
Failed merges:
r? `@ghost`
`@rustbot` modify labels: rollup
@bors
bors
merged commit 55f8b5f
into
rust-lang:masterNov 27, 2021
@rustbotrustbot
added this to the 1.59.0 milestone
Nov 27, 2021
@camelidcamelid
mentioned this pull request
Nov 28, 2021

Closed

@jsha
jsha
deleted the

static-file-replace

branch
November 28, 2021 04:52
@Folyd
Folyd
commented
Dec 7, 2021

Copy link


Copy Markdown

Contributor
Ohhh, this PR broke my extension huhu/rust-search-extension#134. 😅
Rust search extension relies on the search-index.js. I hope we can keep the search-index.js loading steadily. Would you mind CC me if the search-index.js loading method has changed? Thanks. ❤️ @jsha@GuillaumeGomez
@jyn514
jyn514
commented
Dec 7, 2021

Copy link


Copy Markdown

Member
@Folyd you can set up an automatic ping in the highfive bot if you like - here's an example: https://github.com/rust-lang/highfive/blob/6e2c21639aaeafaeae423b244d353247c507d46a/highfive/configs/rust-lang/rust.json#L134
Folyd added a commit
to Folyd/highfive
that referenced
this pull request
Dec 7, 2021
@Folyd
Add new reviewer to librustdoc static files
747b4c4
Ping @Folyd if some changes occurred in librustdoc's HTML/CSS/JS.
Related context: rust-lang/rust#91062 (comment)
@FolydFolyd
mentioned this pull request
Dec 7, 2021
 Merged

@yvtyvt
mentioned this pull request
Aug 19, 2022

Open

@sypharsyphar
mentioned this pull request
Dec 28, 2022

Open

Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@GuillaumeGomezGuillaumeGomezGuillaumeGomez approved these changes

+1 more reviewer

@jyn514jyn514jyn514 approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

@GuillaumeGomezGuillaumeGomez

Labels

A-rustdoc-uiArea: Rustdoc UI (generated HTML)S-waiting-on-borsStatus: Waiting on bors to run and complete tests. Bors will change the label on completion.T-rustdocRelevant to the rustdoc team, which will review and decide on the PR/issue.

Projects


None yet


Milestone

1.59.0

Development

Successfully merging this pull request may close these issues.

8 participants

@jsha@rust-highfive@rust-log-analyzer@GuillaumeGomez@bors@Folyd@jyn514@rustbot