Skip to content
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.

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

Fix image link in the settings menu #58028

Merged
merged 1 commit into from
Feb 7, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
28 changes: 18 additions & 10 deletions src/librustdoc/html/layout.rs
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ use std::path::PathBuf;

use externalfiles::ExternalHtml;

use html::render::SlashChecker;

#[derive(Clone)]
pub struct Layout {
pub logo: String,
Expand Down Expand Up @@ -176,16 +178,22 @@ pub fn render<T: fmt::Display, S: fmt::Display>(
static_root_path = static_root_path,
root_path = page.root_path,
css_class = page.css_class,
logo = if layout.logo.is_empty() {
format!("<a href='{}{}/index.html'>\
<img src='{static_root_path}rust-logo{suffix}.png' alt='logo' width='100'></a>",
static_root_path=static_root_path,
suffix=page.resource_suffix)
} else {
format!("<a href='{}{}/index.html'>\
<img src='{}' alt='logo' width='100'></a>",
page.root_path, layout.krate,
layout.logo)
logo = {
let p = format!("{}{}", page.root_path, layout.krate);
let p = SlashChecker(&p);
if layout.logo.is_empty() {
format!("<a href='{path}index.html'>\
<img src='{static_root_path}rust-logo{suffix}.png' \
alt='logo' width='100'></a>",
path=p,
static_root_path=static_root_path,
suffix=page.resource_suffix)
} else {
format!("<a href='{}index.html'>\
<img src='{}' alt='logo' width='100'></a>",
p,
layout.logo)
}
},
title = page.title,
description = page.description,
Expand Down
20 changes: 16 additions & 4 deletions src/librustdoc/html/render.rs
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,18 @@ use minifier;
/// A pair of name and its optional document.
pub type NameDoc = (String, Option<String>);

pub struct SlashChecker<'a>(pub &'a str);

impl<'a> Display for SlashChecker<'a> {
fn fmt(&self, f: &mut Formatter) -> fmt::Result {
if !self.0.ends_with("/") && !self.0.is_empty() {
write!(f, "{}/", self.0)
} else {
write!(f, "{}", self.0)
}
}
}

/// Major driving force in all rustdoc rendering. This contains information
/// about where in the tree-like hierarchy rendering is occurring and controls
/// how the current page is being rendered.
Expand Down Expand Up @@ -1140,7 +1152,8 @@ themePicker.onblur = handleThemeButtonsBlur;
krates
.iter()
.map(|s| {
format!("<li><a href=\"{}/index.html\">{}</li>", s, s)
format!("<li><a href=\"{}index.html\">{}</li>",
SlashChecker(s), s)
})
.collect::<String>());
try_err!(layout::render(&mut w, &cx.shared.layout,
Expand Down Expand Up @@ -2074,8 +2087,7 @@ impl Context {
let mut themes = self.shared.themes.clone();
let sidebar = "<p class='location'>Settings</p><div class='sidebar-elems'></div>";
themes.push(PathBuf::from("settings.css"));
let mut layout = self.shared.layout.clone();
layout.krate = String::new();
let layout = self.shared.layout.clone();
try_err!(layout::render(&mut w, &layout,
&page, &sidebar, &settings,
self.shared.css_file_extension.is_some(),
Expand Down Expand Up @@ -2454,7 +2466,7 @@ impl<'a> fmt::Display for Item<'a> {

fn item_path(ty: ItemType, name: &str) -> String {
match ty {
ItemType::Module => format!("{}/index.html", name),
ItemType::Module => format!("{}index.html", SlashChecker(name)),
_ => format!("{}.{}.html", ty.css_class(), name),
}
}
Expand Down
2 changes: 1 addition & 1 deletion src/test/rustdoc/keyword.rs
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
// @has foo/keyword.match.html '//a[@class="keyword"]' 'match'
// @has foo/keyword.match.html '//span[@class="in-band"]' 'Keyword match'
// @has foo/keyword.match.html '//section[@id="main"]//div[@class="docblock"]//p' 'this is a test!'
// @!has foo/index.html '//a/@href' 'foo/index.html'
// @has foo/index.html '//a/@href' '../foo/index.html'
// @!has foo/foo/index.html
// @!has-dir foo/foo
#[doc(keyword = "match")]
Expand Down