Skip to content

Commit cc3ffe4

Browse files
notriddlenotriddle
committed
Tweak breadcrumbs list
1 parent e31a719 commit cc3ffe4

File tree

9 files changed

+39
-34
lines changed

9 files changed

+39
-34
lines changed

‎src/librustdoc/html/static/css/rustdoc.css‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -194,6 +194,11 @@ h1, h2, h3, h4 {
194194
display: flex;
195195
align-items: end;
196196
}
197+
.rustdoc-breadcrumbs a {
198+
padding: 4px 0;
199+
margin: -4px 0;
200+
z-index: 1;
201+
}
197202
/* The only headings that get underlines are:
198203
Markdown-generated headings within the top-doc
199204
Rustdoc-generated h2 section headings (e.g. "Implementations", "Required Methods", etc)

‎src/librustdoc/html/static/js/main.js‎

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
// Local js definitions:
22
/* global addClass, getSettingValue, hasClass, searchState, updateLocalStorage */
3-
/* global onEach, onEachLazy, removeClass, getVar */
3+
/* global onEachLazy, removeClass, getVar */
44

55
"use strict";
66

@@ -1826,14 +1826,11 @@ href="https://doc.rust-lang.org/${channel}/rustdoc/read-documentation/search.htm
18261826
return;
18271827
}
18281828
but.onclick = () => {
1829-
const parent = but.parentElement;
18301829
const path = [];
1831-
1832-
onEach(parent.childNodes, child => {
1833-
if (child.tagName === "A") {
1834-
path.push(child.textContent);
1835-
}
1830+
onEachLazy(document.querySelectorAll(".rustdoc-breadcrumbs a"), a => {
1831+
path.push(a.textContent);
18361832
});
1833+
path.push(document.querySelector("title").textContent.split(" ")[0]);
18371834

18381835
copyContentToClipboard(path.join("::"));
18391836
copyButtonAnimation(but);

‎src/librustdoc/html/templates/print_item.html‎

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,11 @@
11
<div class="main-heading"> {# #}
22
{% if !path_components.is_empty() %}
33
<span class="rustdoc-breadcrumbs">
4-
{% for component in path_components %}
5-
<a href="{{component.path|safe}}index.html">{{component.name}}</a>::<wbr>
4+
{% for (i, component) in path_components.iter().enumerate() %}
5+
{% if i != 0 %}
6+
::<wbr>
7+
{% endif %}
8+
<a href="{{component.path|safe}}index.html">{{component.name}}</a>
69
{% endfor %}
710
</span>
811
{% endif %}
@@ -15,7 +18,7 @@ <h1>
1518
Copy item path {# #}
1619
</button> {# #}
1720
</h1> {# #}
18-
<rustdoc-toolbar></rustdoc-toolbar>
21+
<rustdoc-toolbar></rustdoc-toolbar> {# #}
1922
<span class="sub-heading">
2023
{% if !stability_since_raw.is_empty() %}
2124
{{ stability_since_raw|safe +}}
@@ -26,5 +29,5 @@ <h1>
2629
<a class="src" href="{{href|safe}}">source</a> {#+ #}
2730
{% else %}
2831
{% endmatch %}
29-
</span>
32+
</span> {# #}
3033
</div> {# #}

‎tests/rustdoc-gui/search-result-go-to-first.goml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,5 +16,5 @@ assert-css: ("#main-content", {"display": "none"})
1616
// Now we can check that the feature is working as expected!
1717
go-to: "file://" + |DOC_PATH| + "/test_docs/index.html?search=struct%3AFoo&go_to_first=true"
1818
// Waiting for the page to load...
19-
wait-for-text: (".main-heading .rustdoc-breadcrumbs", "test_docs::")
19+
wait-for-text: (".main-heading .rustdoc-breadcrumbs", "test_docs")
2020
wait-for-text: (".main-heading h1", "Struct FooCopy item path")

‎tests/rustdoc-gui/toggle-click-deadspace.goml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,5 +12,5 @@ assert-attribute-false: (".impl-items .toggle", {"open": ""})
1212

1313
// Click the "Trait" part of "impl Trait" and verify it navigates.
1414
click: "#impl-Trait-for-Foo h3 a:first-of-type"
15-
assert-text: (".main-heading .rustdoc-breadcrumbs", "lib2::")
15+
assert-text: (".main-heading .rustdoc-breadcrumbs", "lib2")
1616
assert-text: (".main-heading h1", "Trait TraitCopy item path")

‎tests/rustdoc/empty-mod-private.rs‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,17 +3,17 @@
33
//@ has 'empty_mod_private/index.html' '//a[@href="foo/index.html"]' 'foo'
44
//@ hasraw 'empty_mod_private/sidebar-items.js' 'foo'
55
//@ matches 'empty_mod_private/foo/index.html' '//h1' 'Module foo'
6-
//@ matches - '//*[@class="rustdoc-breadcrumbs"]' 'empty_mod_private::'
6+
//@ matches - '//*[@class="rustdoc-breadcrumbs"]' 'empty_mod_private'
77
mod foo {}
88

99
//@ has 'empty_mod_private/index.html' '//a[@href="bar/index.html"]' 'bar'
1010
//@ hasraw 'empty_mod_private/sidebar-items.js' 'bar'
1111
//@ matches 'empty_mod_private/bar/index.html' '//h1' 'Module bar'
12-
//@ matches - '//*[@class="rustdoc-breadcrumbs"]' 'empty_mod_private::'
12+
//@ matches - '//*[@class="rustdoc-breadcrumbs"]' 'empty_mod_private'
1313
mod bar {
1414
//@ has 'empty_mod_private/bar/index.html' '//a[@href="baz/index.html"]' 'baz'
1515
//@ hasraw 'empty_mod_private/bar/sidebar-items.js' 'baz'
1616
//@ matches 'empty_mod_private/bar/baz/index.html' '//h1' 'Module baz'
17-
//@ matches - '//*[@class="rustdoc-breadcrumbs"]' 'empty_mod_private::bar::'
17+
//@ matches - '//*[@class="rustdoc-breadcrumbs"]' 'empty_mod_private::bar'
1818
mod baz {}
1919
}

‎tests/rustdoc/empty-mod-public.rs‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
11
//@ has 'empty_mod_public/index.html' '//a[@href="foo/index.html"]' 'foo'
22
//@ hasraw 'empty_mod_public/sidebar-items.js' 'foo'
33
//@ matches 'empty_mod_public/foo/index.html' '//h1' 'Module foo'
4-
//@ matches - '//*[@class="rustdoc-breadcrumbs"]' 'empty_mod_public::'
4+
//@ matches - '//*[@class="rustdoc-breadcrumbs"]' 'empty_mod_public'
55
pub mod foo {}
66

77
//@ has 'empty_mod_public/index.html' '//a[@href="bar/index.html"]' 'bar'
88
//@ hasraw 'empty_mod_public/sidebar-items.js' 'bar'
99
//@ matches 'empty_mod_public/bar/index.html' '//h1' 'Module bar'
10-
//@ matches - '//*[@class="rustdoc-breadcrumbs"]' 'empty_mod_public::'
10+
//@ matches - '//*[@class="rustdoc-breadcrumbs"]' 'empty_mod_public'
1111
pub mod bar {
1212
//@ has 'empty_mod_public/bar/index.html' '//a[@href="baz/index.html"]' 'baz'
1313
//@ hasraw 'empty_mod_public/bar/sidebar-items.js' 'baz'
1414
//@ matches 'empty_mod_public/bar/baz/index.html' '//h1' 'Module baz'
15-
//@ matches - '//*[@class="rustdoc-breadcrumbs"]' 'empty_mod_public::bar::'
15+
//@ matches - '//*[@class="rustdoc-breadcrumbs"]' 'empty_mod_public::bar'
1616
pub mod baz {}
1717
}

‎tests/rustdoc/inline_cross/renamed-via-module.rs‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,18 +11,18 @@ extern crate foo;
1111
//@ has - '//a/[@href="struct.StepBy.html"]' "StepBy"
1212
//@ has foo/iter/struct.DeprecatedStepBy.html
1313
//@ has - '//h1' "Struct DeprecatedStepBy"
14-
//@ matches - '//*[@class="rustdoc-breadcrumbs"]' 'foo::iter::'
14+
//@ matches - '//*[@class="rustdoc-breadcrumbs"]' 'foo::iter'
1515
//@ has foo/iter/struct.StepBy.html
1616
//@ has - '//h1' "Struct StepBy"
17-
//@ matches - '//*[@class="rustdoc-breadcrumbs"]' 'foo::iter::'
17+
//@ matches - '//*[@class="rustdoc-breadcrumbs"]' 'foo::iter'
1818

1919
//@ has bar/iter/index.html
2020
//@ has - '//a/[@href="struct.DeprecatedStepBy.html"]' "DeprecatedStepBy"
2121
//@ has - '//a/[@href="struct.StepBy.html"]' "StepBy"
2222
//@ has bar/iter/struct.DeprecatedStepBy.html
2323
//@ has - '//h1' "Struct DeprecatedStepBy"
24-
//@ matches - '//*[@class="rustdoc-breadcrumbs"]' 'bar::iter::'
24+
//@ matches - '//*[@class="rustdoc-breadcrumbs"]' 'bar::iter'
2525
//@ has bar/iter/struct.StepBy.html
2626
//@ has - '//h1' "Struct StepBy"
27-
//@ matches - '//*[@class="rustdoc-breadcrumbs"]' 'bar::iter::'
27+
//@ matches - '//*[@class="rustdoc-breadcrumbs"]' 'bar::iter'
2828
pub use foo::iter;

‎tests/rustdoc/titles.rs‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -6,44 +6,44 @@
66
//@ count 'foo/index.html' '//h2[@class="location"]' 0
77

88
//@ matches 'foo/foo_mod/index.html' '//h1' 'Module foo_mod'
9-
//@ matches - '//*[@class="rustdoc-breadcrumbs"]' 'foo::'
9+
//@ matches - '//*[@class="rustdoc-breadcrumbs"]' 'foo'
1010
//@ matches - '//h2[@class="location"]' 'Module foo_mod'
1111
pub mod foo_mod {
1212
pub struct __Thing {}
1313
}
1414

1515
extern "C" {
1616
//@ matches 'foo/fn.foo_ffn.html' '//h1' 'Function foo_ffn'
17-
//@ matches - '//*[@class="rustdoc-breadcrumbs"]' 'foo::'
17+
//@ matches - '//*[@class="rustdoc-breadcrumbs"]' 'foo'
1818
pub fn foo_ffn();
1919
}
2020

2121
//@ matches 'foo/fn.foo_fn.html' '//h1' 'Function foo_fn'
22-
//@ matches - '//*[@class="rustdoc-breadcrumbs"]' 'foo::'
22+
//@ matches - '//*[@class="rustdoc-breadcrumbs"]' 'foo'
2323
pub fn foo_fn() {}
2424

2525
//@ matches 'foo/trait.FooTrait.html' '//h1' 'Trait FooTrait'
26-
//@ matches - '//*[@class="rustdoc-breadcrumbs"]' 'foo::'
26+
//@ matches - '//*[@class="rustdoc-breadcrumbs"]' 'foo'
2727
//@ matches - '//h2[@class="location"]' 'FooTrait'
2828
pub trait FooTrait {}
2929

3030
//@ matches 'foo/struct.FooStruct.html' '//h1' 'Struct FooStruct'
31-
//@ matches - '//*[@class="rustdoc-breadcrumbs"]' 'foo::'
31+
//@ matches - '//*[@class="rustdoc-breadcrumbs"]' 'foo'
3232
//@ matches - '//h2[@class="location"]' 'FooStruct'
3333
pub struct FooStruct;
3434

3535
//@ matches 'foo/enum.FooEnum.html' '//h1' 'Enum FooEnum'
36-
//@ matches - '//*[@class="rustdoc-breadcrumbs"]' 'foo::'
36+
//@ matches - '//*[@class="rustdoc-breadcrumbs"]' 'foo'
3737
//@ matches - '//h2[@class="location"]' 'FooEnum'
3838
pub enum FooEnum {}
3939

4040
//@ matches 'foo/type.FooType.html' '//h1' 'Type Alias FooType'
41-
//@ matches - '//*[@class="rustdoc-breadcrumbs"]' 'foo::'
41+
//@ matches - '//*[@class="rustdoc-breadcrumbs"]' 'foo'
4242
//@ matches - '//h2[@class="location"]' 'FooType'
4343
pub type FooType = FooStruct;
4444

4545
//@ matches 'foo/macro.foo_macro.html' '//h1' 'Macro foo_macro'
46-
//@ matches - '//*[@class="rustdoc-breadcrumbs"]' 'foo::'
46+
//@ matches - '//*[@class="rustdoc-breadcrumbs"]' 'foo'
4747
#[macro_export]
4848
macro_rules! foo_macro {
4949
() => {};
@@ -55,15 +55,15 @@ macro_rules! foo_macro {
5555
mod bool {}
5656

5757
//@ matches 'foo/static.FOO_STATIC.html' '//h1' 'Static FOO_STATIC'
58-
//@ matches - '//*[@class="rustdoc-breadcrumbs"]' 'foo::'
58+
//@ matches - '//*[@class="rustdoc-breadcrumbs"]' 'foo'
5959
pub static FOO_STATIC: FooStruct = FooStruct;
6060

6161
extern "C" {
6262
//@ matches 'foo/static.FOO_FSTATIC.html' '//h1' 'Static FOO_FSTATIC'
63-
//@ matches - '//*[@class="rustdoc-breadcrumbs"]' 'foo::'
63+
//@ matches - '//*[@class="rustdoc-breadcrumbs"]' 'foo'
6464
pub static FOO_FSTATIC: FooStruct;
6565
}
6666

6767
//@ matches 'foo/constant.FOO_CONSTANT.html' '//h1' 'Constant FOO_CONSTANT'
68-
//@ matches - '//*[@class="rustdoc-breadcrumbs"]' 'foo::'
68+
//@ matches - '//*[@class="rustdoc-breadcrumbs"]' 'foo'
6969
pub const FOO_CONSTANT: FooStruct = FooStruct;

0 commit comments

Comments
 (0)