Yehowshua/ZIm
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

rustdoc: Strip out additional chrome (#13172)

Browse source 
This PR updates the HTML to Markdown converter for rustdoc to strip out
some additional chrome.

Namely, anchors and links to source files.

Release Notes:

- N/A
This commit is contained in:
Marshall Bowers 2024-06-17 16:44:15 -04:00 • committed by GitHub
parent bb1d52b485
commit 7aa28c9b24
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 10 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

15
crates/rustdoc/src/to_markdown.rs
View file

@ -61,7 +61,7 @@ impl HandleTag for RustdocHeadingHandler {
|| writer.is_inside("h6")
{
let text = text
.trim_matches(|char| char == '\n' || char == '\r' || char == '§')
.trim_matches(|char| char == '\n' || char == '\r')
.replace('\n', " ");
writer.push_str(&text);
@ -212,7 +212,7 @@ pub struct RustdocChromeRemover;
impl HandleTag for RustdocChromeRemover {
fn should_handle(&self, tag: &str) -> bool {
match tag {
"head" | "script" | "nav" | "summary" | "button" | "div" | "span" => true,
"head" | "script" | "nav" | "summary" | "button" | "a" | "div" | "span" => true,
_ => false,
}
}
@ -234,12 +234,17 @@ impl HandleTag for RustdocChromeRemover {
return StartTagOutcome::Skip;
}
}
"div" | "span" => {
let classes_to_skip = ["nav-container", "sidebar-elems", "out-of-band"];
if tag.has_any_classes(&classes_to_skip) {
"a" => {
if tag.has_any_classes(&["anchor", "doc-anchor", "src"]) {
return StartTagOutcome::Skip;
}
}
"div" | "span" => {
if tag.has_any_classes(&["nav-container", "sidebar-elems", "out-of-band"]) {
return StartTagOutcome::Skip;
}
}
_ => {}
}