Skip to content

rustdoc: use src consistently over source in CSS/JS #113709

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jul 15, 2023
Merged

rustdoc: use src consistently over source in CSS/JS #113709

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
34bc8fb
rustdoc: use `src` consistently over `source` in code
notriddle Jul 14, 2023
e72fba4
rustdoc: use `src` consistently over `source` in JavaScript
notriddle Jul 14, 2023
d7d0a45
rustdoc: rename to `src-script.js`
notriddle Jul 14, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions src/librustdoc/html/render/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1821,9 +1821,9 @@ fn render_rightside(
);
if let Some(l) = src_href {
if has_stability {
write!(rightside, " · <a class=\"srclink\" href=\"{}\">source</a>", l)
write!(rightside, " · <a class=\"src\" href=\"{}\">source</a>", l)
} else {
write!(rightside, "<a class=\"srclink rightside\" href=\"{}\">source</a>", l)
write!(rightside, "<a class=\"src rightside\" href=\"{}\">source</a>", l)
}
}
if has_stability && has_src_ref {
Expand Down
8 changes: 4 additions & 4 deletions src/librustdoc/html/render/write_shared.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -270,7 +270,7 @@ pub(super) fn write_shared(
hierarchy.add_path(source);
}
let hierarchy = Rc::try_unwrap(hierarchy).unwrap();
let dst = cx.dst.join(&format!("source-files{}.js", cx.shared.resource_suffix));
let dst = cx.dst.join(&format!("src-files{}.js", cx.shared.resource_suffix));
let make_sources = || {
let (mut all_sources, _krates) =
try_err!(collect_json(&dst, krate.name(cx.tcx()).as_str()), &dst);
Expand All @@ -286,12 +286,12 @@ pub(super) fn write_shared(
.replace("\\\"", "\\\\\"")
));
all_sources.sort();
let mut v = String::from("var sourcesIndex = JSON.parse('{\\\n");
let mut v = String::from("var srcIndex = JSON.parse('{\\\n");
v.push_str(&all_sources.join(",\\\n"));
v.push_str("\\\n}');\ncreateSourceSidebar();\n");
v.push_str("\\\n}');\ncreateSrcSidebar();\n");
Ok(v.into_bytes())
};
write_invocation_specific("source-files.js", &make_sources)?;
write_invocation_specific("src-files.js", &make_sources)?;
}

// Update the search index and crate list.
Expand Down
2 changes: 1 addition & 1 deletion src/librustdoc/html/sources.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -227,7 +227,7 @@ impl SourceCollector<'_, '_> {
let desc = format!("Source of the Rust file `{}`.", filename.prefer_remapped());
let page = layout::Page {
title: &title,
css_class: "source",
css_class: "src",
root_path: &root_path,
static_root_path: shared.static_root_path.as_deref(),
description: &desc,
Expand Down
2 changes: 1 addition & 1 deletion src/librustdoc/html/static/css/noscript.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ nav.sub {
display: none;
}

.source .sidebar {
.src .sidebar {
display: none;
}

Expand Down
60 changes: 30 additions & 30 deletions src/librustdoc/html/static/css/rustdoc.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -194,7 +194,7 @@ h1, h2, h3, h4, h5, h6,
.item-name > a,
.out-of-band,
span.since,
a.srclink,
a.src,
#help-button > a,
summary.hideme,
.scraped-example-list,
Expand All @@ -206,7 +206,7 @@ ul.all-items {
#toggle-all-docs,
a.anchor,
.small-section-header a,
#source-sidebar a,
#src-sidebar a,
.rust a,
.sidebar h2 a,
.sidebar h3 a,
Expand Down Expand Up @@ -315,7 +315,7 @@ main {
min-width: 0; /* avoid growing beyond the size limit */
}

.source main {
.src main {
padding: 15px;
}

Expand Down Expand Up @@ -350,10 +350,10 @@ pre.item-decl {
contain: initial;
}

.source .content pre {
.src .content pre {
padding: 20px;
}
.rustdoc.source .example-wrap pre.src-line-numbers {
.rustdoc.src .example-wrap pre.src-line-numbers {
padding: 20px 0 20px 4px;
}

Expand Down Expand Up @@ -392,7 +392,7 @@ img {
left: 0;
}

.rustdoc.source .sidebar {
.rustdoc.src .sidebar {
flex-basis: 50px;
border-right: 1px solid;
overflow-x: hidden;
Expand All @@ -402,24 +402,24 @@ img {
}

.sidebar, .mobile-topbar, .sidebar-menu-toggle,
#src-sidebar-toggle, #source-sidebar {
#src-sidebar-toggle, #src-sidebar {
background-color: var(--sidebar-background-color);
}

#src-sidebar-toggle > button:hover, #src-sidebar-toggle > button:focus {
background-color: var(--sidebar-background-color-hover);
}

.source .sidebar > *:not(#src-sidebar-toggle) {
.src .sidebar > *:not(#src-sidebar-toggle) {
visibility: hidden;
}

.source-sidebar-expanded .source .sidebar {
.src-sidebar-expanded .src .sidebar {
overflow-y: auto;
flex-basis: 300px;
}

.source-sidebar-expanded .source .sidebar > *:not(#src-sidebar-toggle) {
.src-sidebar-expanded .src .sidebar > *:not(#src-sidebar-toggle) {
visibility: visible;
}

Expand Down Expand Up @@ -544,7 +544,7 @@ ul.block, .block li {
flex-grow: 1;
}

.rustdoc:not(.source) .example-wrap pre {
.rustdoc:not(.src) .example-wrap pre {
overflow: auto hidden;
}

Expand Down Expand Up @@ -619,7 +619,7 @@ ul.block, .block li {
}

.docblock code, .docblock-short code,
pre, .rustdoc.source .example-wrap {
pre, .rustdoc.src .example-wrap {
background-color: var(--code-block-background-color);
}

Expand Down Expand Up @@ -676,7 +676,7 @@ nav.sub {
height: 34px;
flex-grow: 1;
}
.source nav.sub {
.src nav.sub {
margin: 0 0 15px 0;
}

Expand Down Expand Up @@ -1074,7 +1074,7 @@ pre.rust .doccomment {
color: var(--code-highlight-doc-comment-color);
}

.rustdoc.source .example-wrap pre.rust a {
.rustdoc.src .example-wrap pre.rust a {
background: var(--codeblock-link-background);
}

Expand Down Expand Up @@ -1301,22 +1301,22 @@ a.tooltip:hover::after {
align-items: stretch;
z-index: 10;
}
#source-sidebar {
#src-sidebar {
width: 100%;
overflow: auto;
}
#source-sidebar > .title {
#src-sidebar > .title {
font-size: 1.5rem;
text-align: center;
border-bottom: 1px solid var(--border-color);
margin-bottom: 6px;
}
#source-sidebar div.files > a:hover, details.dir-entry summary:hover,
#source-sidebar div.files > a:focus, details.dir-entry summary:focus {
background-color: var(--source-sidebar-background-hover);
#src-sidebar div.files > a:hover, details.dir-entry summary:hover,
#src-sidebar div.files > a:focus, details.dir-entry summary:focus {
background-color: var(--src-sidebar-background-hover);
}
#source-sidebar div.files > a.selected {
background-color: var(--source-sidebar-background-selected);
#src-sidebar div.files > a.selected {
background-color: var(--src-sidebar-background-selected);
}
#src-sidebar-toggle > button {
font-size: inherit;
Expand Down Expand Up @@ -1562,7 +1562,7 @@ However, it's not needed with smaller screen width because the doc/code block is
/*
WARNING: RUSTDOC_MOBILE_BREAKPOINT MEDIA QUERY
If you update this line, then you also need to update the line with the same warning
in source-script.js
in src-script.js
*/
@media (max-width: 700px) {
/* When linking to an item with an `id` (for instance, by clicking a link in the sidebar,
Expand Down Expand Up @@ -1619,17 +1619,17 @@ in source-script.js

/* The source view uses a different design for the sidebar toggle, and doesn't have a topbar,
so don't bump down the main content or the sidebar. */
.source main,
.rustdoc.source .sidebar {
.src main,
.rustdoc.src .sidebar {
top: 0;
padding: 0;
height: 100vh;
border: 0;
}

.sidebar.shown,
.source-sidebar-expanded .source .sidebar,
.rustdoc:not(.source) .sidebar:focus-within {
.src-sidebar-expanded .src .sidebar,
.rustdoc:not(.src) .sidebar:focus-within {
left: 0;
}

Expand Down Expand Up @@ -1709,7 +1709,7 @@ in source-script.js
border-left: 0;
}

.source-sidebar-expanded #src-sidebar-toggle {
.src-sidebar-expanded #src-sidebar-toggle {
left: unset;
top: unset;
width: unset;
Expand Down Expand Up @@ -1749,7 +1749,7 @@ in source-script.js
display: inline;
}

.source-sidebar-expanded .source .sidebar {
.src-sidebar-expanded .src .sidebar {
max-width: 100vw;
width: 100vw;
}
Expand All @@ -1769,7 +1769,7 @@ in source-script.js
margin-left: 34px;
}

.source nav.sub {
.src nav.sub {
margin: 0;
padding: var(--nav-sub-mobile-padding);
}
Expand All @@ -1792,7 +1792,7 @@ in source-script.js
}

@media print {
nav.sidebar, nav.sub, .out-of-band, a.srclink, #copy-path,
nav.sidebar, nav.sub, .out-of-band, a.src, #copy-path,
details.toggle[open] > summary::before, details.toggle > summary::before,
details.toggle.top-doc > summary {
display: none;
Expand Down
14 changes: 7 additions & 7 deletions src/librustdoc/html/static/css/themes/ayu.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,8 +89,8 @@ Original by Dempfi (https://github.com/dempfi/ayu)
--crate-search-div-hover-filter: invert(98%) sepia(12%) saturate(81%) hue-rotate(343deg)
brightness(113%) contrast(76%);
--crate-search-hover-border: #e0e0e0;
--source-sidebar-background-selected: #14191f;
--source-sidebar-background-hover: #14191f;
--src-sidebar-background-selected: #14191f;
--src-sidebar-background-hover: #14191f;
--table-alt-row-background-color: #191f26;
--codeblock-link-background: #333;
--scrape-example-toggle-line-background: #999;
Expand All @@ -107,7 +107,7 @@ Original by Dempfi (https://github.com/dempfi/ayu)

h1, h2, h3, h4,
h1 a, .sidebar h2 a, .sidebar h3 a,
#source-sidebar > .title {
#src-sidebar > .title {
color: #fff;
}
h4 {
Expand All @@ -124,15 +124,15 @@ h4 {
.docblock pre > code,
pre, pre > code,
.item-info code,
.rustdoc.source .example-wrap {
.rustdoc.src .example-wrap {
color: #e6e1cf;
}

.sidebar .current,
.sidebar a:hover,
#source-sidebar div.files > a:hover, details.dir-entry summary:hover,
#source-sidebar div.files > a:focus, details.dir-entry summary:focus,
#source-sidebar div.files > a.selected {
#src-sidebar div.files > a:hover, details.dir-entry summary:hover,
#src-sidebar div.files > a:focus, details.dir-entry summary:focus,
#src-sidebar div.files > a.selected {
color: #ffb44c;
}

Expand Down
4 changes: 2 additions & 2 deletions src/librustdoc/html/static/css/themes/dark.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,8 +84,8 @@
--crate-search-div-hover-filter: invert(69%) sepia(60%) saturate(6613%) hue-rotate(184deg)
brightness(100%) contrast(91%);
--crate-search-hover-border: #2196f3;
--source-sidebar-background-selected: #333;
--source-sidebar-background-hover: #444;
--src-sidebar-background-selected: #333;
--src-sidebar-background-hover: #444;
--table-alt-row-background-color: #2A2A2A;
--codeblock-link-background: #333;
--scrape-example-toggle-line-background: #999;
Expand Down
4 changes: 2 additions & 2 deletions src/librustdoc/html/static/css/themes/light.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,8 +81,8 @@
--crate-search-div-hover-filter: invert(44%) sepia(18%) saturate(23%) hue-rotate(317deg)
brightness(96%) contrast(93%);
--crate-search-hover-border: #717171;
--source-sidebar-background-selected: #fff;
--source-sidebar-background-hover: #e0e0e0;
--src-sidebar-background-selected: #fff;
--src-sidebar-background-hover: #e0e0e0;
--table-alt-row-background-color: #F5F5F5;
--codeblock-link-background: #eee;
--scrape-example-toggle-line-background: #ccc;
Expand Down
Loading