Skip to content

Commit

Permalink
Rollup merge of #91102 - jsha:theme-anchor, r=GuillaumeGomez
Browse files Browse the repository at this point in the history
Set color for <a> in a more straightforward way.

Previously, we set the default color for <a> tags to black, and then had an override with a bunch of not() clauses to set anchors in
docblocks to blue.

Instead, we should set the default color for <a> to blue (or equivalent in other themes), and override it for places like the sidebar or search results, where we don't want them to be styled as links.

Demo at https://rustdoc.crud.net/jsha/theme-anchor/std/string/struct.String.html. This should result in no visible changes.

r? `@GuillaumeGomez`
  • Loading branch information
matthiaskrgr committed Nov 22, 2021
2 parents 936f260 + a56559d commit cb77767
Show file tree
Hide file tree
Showing 6 changed files with 60 additions and 32 deletions.
4 changes: 0 additions & 4 deletions src/librustdoc/html/static/css/rustdoc.css
Original file line number Diff line number Diff line change
Expand Up @@ -1078,10 +1078,6 @@ a.test-arrow:hover{
text-decoration: none;
}

.section-header a {
color: inherit;
}

.code-attribute {
font-weight: 300;
}
Expand Down
17 changes: 11 additions & 6 deletions src/librustdoc/html/static/css/themes/ayu.css
Original file line number Diff line number Diff line change
Expand Up @@ -214,18 +214,23 @@ nav.main .separator {
border: 1px solid #5c6773;
}
a {
color: #39AFD7;
}
a.srclink,
a#toggle-all-docs,
#source-sidebar a,
pre.rust a,
.sidebar a,
.in-band a {
color: #c5c5c5;
}
.search-results a {
color: #0096cf;
}
body.source .example-wrap pre.rust a {
background: #333;
}

.docblock:not(.item-decl) a:not(.srclink):not(.test-arrow),
.docblock-short a:not(.srclink):not(.test-arrow), .item-info a,
#help a {
color: #39AFD7;
}

details.rustdoc-toggle > summary.hideme > span,
details.rustdoc-toggle > summary::before,
details.undocumented > summary::before {
Expand Down
23 changes: 14 additions & 9 deletions src/librustdoc/html/static/css/themes/dark.css
Original file line number Diff line number Diff line change
Expand Up @@ -174,22 +174,27 @@ nav.main .current {
nav.main .separator {
border-color: #eee;
}

a {
color: #ddd;
color: #D2991D;
}
body.source .example-wrap pre.rust a {
background: #333;
a.srclink,
a#toggle-all-docs,
#source-sidebar a,
pre.rust a,
.sidebar a,
.in-band a {
color: #ddd;
}

.docblock:not(.item-decl) a:not(.srclink):not(.test-arrow),
.docblock-short a:not(.srclink):not(.test-arrow), .item-info a,
#help a {
color: #D2991D;
.search-results a {
color: #ddd;
}

a.test-arrow {
color: #dedede;
}
body.source .example-wrap pre.rust a {
background: #333;
}

details.rustdoc-toggle > summary.hideme > span,
details.rustdoc-toggle > summary::before,
Expand Down
23 changes: 14 additions & 9 deletions src/librustdoc/html/static/css/themes/light.css
Original file line number Diff line number Diff line change
Expand Up @@ -169,22 +169,27 @@ nav.main .current {
nav.main .separator {
border: 1px solid #000;
}

a {
color: #000;
color: #3873AD;
}
body.source .example-wrap pre.rust a {
background: #eee;
a.srclink,
a#toggle-all-docs,
#source-sidebar a,
pre.rust a,
.sidebar a,
.in-band a {
color: #000;
}

.docblock:not(.item-decl) a:not(.srclink):not(.test-arrow),
.docblock-short a:not(.srclink):not(.test-arrow), .item-info a,
#help a {
color: #3873AD;
.search-results a {
color: initial;
}

a.test-arrow {
color: #f5f5f5;
}
body.source .example-wrap pre.rust a {
background: #eee;
}

details.rustdoc-toggle > summary.hideme > span,
details.rustdoc-toggle > summary::before,
Expand Down
17 changes: 17 additions & 0 deletions src/test/rustdoc-gui/anchors.goml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
goto: file://|DOC_PATH|/test_docs/struct.HeavilyDocumentedStruct.html

// Set the theme to light.
local-storage: {"rustdoc-theme": "light", "rustdoc-use-system-theme": "false"}
// We reload the page so the local storage settings are being used.
reload:

assert-css: ("#toggle-all-docs", {"color": "rgba(0, 0, 0, 0)"})
assert-css: (".fqn .in-band a:nth-of-type(1)", {"color": "rgba(0, 0, 0, 0)"})
assert-css: (".fqn .in-band a:nth-of-type(2)", {"color": "rgba(0, 0, 0, 0)"})
assert-css: (".srclink", {"color": "rgba(0, 0, 0, 0)"})
assert-css: (".srclink", {"color": "rgba(0, 0, 0, 0)"})

assert-css: ("#top-doc-prose-title", {"color": "rgba(0, 0, 0, 0)"})

assert-css: (".sidebar a", {"color": "rgba(0, 0, 0, 0)"})
assert-css: (".in-band a", {"color": "rgba(0, 0, 0, 0)"})
8 changes: 4 additions & 4 deletions src/tools/rustdoc-gui/tester.js
Original file line number Diff line number Diff line change
Expand Up @@ -194,7 +194,7 @@ async function main(argv) {
.then(out => {
const [output, nb_failures] = out;
results[nb_failures === 0 ? "successful" : "failed"].push({
file_name: file_name,
file_name: testPath,
output: output,
});
if (nb_failures > 0) {
Expand All @@ -206,7 +206,7 @@ async function main(argv) {
})
.catch(err => {
results.errored.push({
file_name: file_name,
file_name: testPath + file_name,
output: err,
});
status_bar.erroneous();
Expand Down Expand Up @@ -239,15 +239,15 @@ async function main(argv) {
console.log("");
results.failed.sort(by_filename);
results.failed.forEach(r => {
console.log(r.output);
console.log(r.file_name, r.output);
});
}
if (results.errored.length > 0) {
console.log(os.EOL);
// print run errors on the bottom so developers see them better
results.errored.sort(by_filename);
results.errored.forEach(r => {
console.error(r.output);
console.error(r.file_name, r.output);
});
}

Expand Down

0 comments on commit cb77767

Please sign in to comment.