bjoernager/rust
bjoernager/rust
1
Fork 0
Code Issues Pull requests Activity
rust/src/librustdoc/html/layout.rs

114 lines
3.4 KiB
Rust
Raw Normal View History

Fasten even more theme switch
2018-01-23 00:45:34 +01:00
use std::path::PathBuf;
Implement a web backend for rustdoc_ng This large commit implements and `html` output option for rustdoc_ng. The executable has been altered to be invoked as "rustdoc_ng html <crate>" and it will dump everything into the local "doc" directory. JSON can still be generated by changing 'html' to 'json'. This also fixes a number of bugs in rustdoc_ng relating to comment stripping, along with some other various issues that I found along the way. The `make doc` command has been altered to generate the new documentation into the `doc/ng/$(CRATE)` directories.
2013-09-18 22:18:38 -07:00
Fix rustc::internal lints on rustdoc
2020-12-31 23:25:30 -05:00
use rustc_data_structures::fx::FxHashMap;
Transition librustdoc to 2018 edition
2019-02-23 16:40:07 +09:00
use crate::externalfiles::ExternalHtml;
Apply review comments
2019-10-10 12:09:01 +02:00
use crate::html::escape::Escape;
Move sidebar to Buffer-printing
2019-08-31 09:07:29 -04:00
use crate::html::format::{Buffer, Print};
Clean up handling of style files in rustdoc Disable all themes other than `light.css` to prevent rule conflicts
2020-07-12 14:37:22 -04:00
use crate::html::render::{ensure_trailing_slash, StylePath};
Fix image link in the settings menu
2019-01-31 15:42:45 +01:00
Use Tera templates for rustdoc. Replaces a format!() call in layout::render with a template expansion. Introduces a `templates` field in SharedContext so parts of rustdoc can share pre-rendered templates. This currently builds in a copy of the single template available, like with static files. However, future work can make this live-loadable with a perma-unstable flag, to make rustdoc developers' work easier.
2021-06-08 17:19:03 -07:00
use serde::Serialize;
#[derive(Clone, Serialize)]
Make all rustdoc functions and structs crate-private This gives warnings about dead code.
2020-11-14 17:59:58 -05:00
crate struct Layout {
crate logo: String,
crate favicon: String,
crate external_html: ExternalHtml,
Fix rustc::internal lints on rustdoc
2020-12-31 23:25:30 -05:00
crate default_settings: FxHashMap<String, String>,
Make all rustdoc functions and structs crate-private This gives warnings about dead code.
2020-11-14 17:59:58 -05:00
crate krate: String,
Move constant parameters to render to Layout struct
2019-08-30 10:51:13 -04:00
/// The given user css file which allow to customize the generated
/// documentation theme.
Make all rustdoc functions and structs crate-private This gives warnings about dead code.
2020-11-14 17:59:58 -05:00
crate css_file_extension: Option<PathBuf>,
Move constant parameters to render to Layout struct
2019-08-30 10:51:13 -04:00
/// If false, the `select` element to have search filtering by crates on rendered docs
/// won't be generated.
Make all rustdoc functions and structs crate-private This gives warnings about dead code.
2020-11-14 17:59:58 -05:00
crate generate_search_filter: bool,
Move JS into a standalone file
2021-10-01 13:05:35 -07:00
/// If true, then scrape-examples.js will be included in the output HTML file
crate scrape_examples_extension: bool,
Implement a web backend for rustdoc_ng This large commit implements and `html` output option for rustdoc_ng. The executable has been altered to be invoked as "rustdoc_ng html <crate>" and it will dump everything into the local "doc" directory. JSON can still be generated by changing 'html' to 'json'. This also fixes a number of bugs in rustdoc_ng relating to comment stripping, along with some other various issues that I found along the way. The `make doc` command has been altered to generate the new documentation into the `doc/ng/$(CRATE)` directories.
2013-09-18 22:18:38 -07:00
}
Use Tera templates for rustdoc. Replaces a format!() call in layout::render with a template expansion. Introduces a `templates` field in SharedContext so parts of rustdoc can share pre-rendered templates. This currently builds in a copy of the single template available, like with static files. However, future work can make this live-loadable with a perma-unstable flag, to make rustdoc developers' work easier.
2021-06-08 17:19:03 -07:00
#[derive(Serialize)]
Make all rustdoc functions and structs crate-private This gives warnings about dead code.
2020-11-14 17:59:58 -05:00
crate struct Page<'a> {
crate title: &'a str,
crate css_class: &'a str,
crate root_path: &'a str,
crate static_root_path: Option<&'a str>,
crate description: &'a str,
crate keywords: &'a str,
crate resource_suffix: &'a str,
crate extra_scripts: &'a [&'a str],
crate static_extra_scripts: &'a [&'a str],
Implement a web backend for rustdoc_ng This large commit implements and `html` output option for rustdoc_ng. The executable has been altered to be invoked as "rustdoc_ng html <crate>" and it will dump everything into the local "doc" directory. JSON can still be generated by changing 'html' to 'json'. This also fixes a number of bugs in rustdoc_ng relating to comment stripping, along with some other various issues that I found along the way. The `make doc` command has been altered to generate the new documentation into the `doc/ng/$(CRATE)` directories.
2013-09-18 22:18:38 -07:00
}
Use an SVG image for clipboard instead of unicode character
2021-05-09 20:41:24 +02:00
impl<'a> Page<'a> {
crate fn get_static_root_path(&self) -> &str {
self.static_root_path.unwrap_or(self.root_path)
}
}
Use Tera templates for rustdoc. Replaces a format!() call in layout::render with a template expansion. Introduces a `templates` field in SharedContext so parts of rustdoc can share pre-rendered templates. This currently builds in a copy of the single template available, like with static files. However, future work can make this live-loadable with a perma-unstable flag, to make rustdoc developers' work easier.
2021-06-08 17:19:03 -07:00
#[derive(Serialize)]
struct PageLayout<'a> {
static_root_path: &'a str,
page: &'a Page<'a>,
layout: &'a Layout,
style_files: String,
sidebar: String,
content: String,
krate_with_trailing_slash: String,
}
Make all rustdoc functions and structs crate-private This gives warnings about dead code.
2020-11-14 17:59:58 -05:00
crate fn render<T: Print, S: Print>(
Use Tera templates for rustdoc. Replaces a format!() call in layout::render with a template expansion. Introduces a `templates` field in SharedContext so parts of rustdoc can share pre-rendered templates. This currently builds in a copy of the single template available, like with static files. However, future work can make this live-loadable with a perma-unstable flag, to make rustdoc developers' work easier.
2021-06-08 17:19:03 -07:00
templates: &tera::Tera,
Add no-crate filter option on rustdoc
2018-12-20 13:28:55 +01:00
layout: &Layout,
Transition librustdoc to 2018 edition
2019-02-23 16:40:07 +09:00
page: &Page<'_>,
Implement Print for FnOnce(&mut Buffer) This means that callers can pass in a closure like `|buf| some_function(..., &mut buf)` and pass in arbitrary arguments to that function without complicating the trait definition. We also keep the impl for str and String, since it's useful to be able to just pass in "" or format!("{}"...) results in some cases. This changes Print's definition to take self, instead of &self, because otherwise FnOnce cannot be called directly. We could instead take FnMut or even Fn, but that seems like it'd merely complicate matters -- most of the time, the FnOnce does not constrain us at all anyway. If it does, a custom Print impl for &'_ SomeStruct is not all that painful.
2019-08-31 11:22:51 -04:00
sidebar: S,
layout::render takes Print instead of fmt::Display
2019-08-31 12:18:25 -04:00
t: T,
Clean up handling of style files in rustdoc Disable all themes other than `light.css` to prevent rule conflicts
2020-07-12 14:37:22 -04:00
style_files: &[StylePath],
Create buffers in top-level rendering This avoids needlessly creating and threading the buffers through when we only use them once.
2019-08-30 10:35:14 -04:00
) -> String {
Use an SVG image for clipboard instead of unicode character
2021-05-09 20:41:24 +02:00
let static_root_path = page.get_static_root_path();
Use Tera templates for rustdoc. Replaces a format!() call in layout::render with a template expansion. Introduces a `templates` field in SharedContext so parts of rustdoc can share pre-rendered templates. This currently builds in a copy of the single template available, like with static files. However, future work can make this live-loadable with a perma-unstable flag, to make rustdoc developers' work easier.
2021-06-08 17:19:03 -07:00
let krate_with_trailing_slash = ensure_trailing_slash(&layout.krate).to_string();
let style_files = style_files
.iter()
Fix clippy lints in librustdoc
2021-10-01 17:12:39 +02:00
.filter_map(|t| t.path.file_stem().map(|stem| (stem, t.disabled)))
.filter_map(|t| t.0.to_str().map(|path| (path, t.1)))
Use Tera templates for rustdoc. Replaces a format!() call in layout::render with a template expansion. Introduces a `templates` field in SharedContext so parts of rustdoc can share pre-rendered templates. This currently builds in a copy of the single template available, like with static files. However, future work can make this live-loadable with a perma-unstable flag, to make rustdoc developers' work easier.
2021-06-08 17:19:03 -07:00
.map(|t| {
Format the world
2019-12-22 17:42:04 -05:00
format!(
Clean up handling of style files in rustdoc Disable all themes other than `light.css` to prevent rule conflicts
2020-07-12 14:37:22 -04:00
r#"<link rel="stylesheet" type="text/css" href="{}.css" {} {}>"#,
Escape(&format!("{}{}{}", static_root_path, t.0, page.resource_suffix)),
if t.1 { "disabled" } else { "" },
if t.0 == "light" { "id=\"themeStyle\"" } else { "" }
Use Tera templates for rustdoc. Replaces a format!() call in layout::render with a template expansion. Introduces a `templates` field in SharedContext so parts of rustdoc can share pre-rendered templates. This currently builds in a copy of the single template available, like with static files. However, future work can make this live-loadable with a perma-unstable flag, to make rustdoc developers' work easier.
2021-06-08 17:19:03 -07:00
)
})
.collect::<String>();
let content = Buffer::html().to_display(t); // Note: This must happen before making the sidebar.
let sidebar = Buffer::html().to_display(sidebar);
let teractx = tera::Context::from_serialize(PageLayout {
static_root_path,
page,
layout,
style_files,
sidebar,
content,
krate_with_trailing_slash,
})
.unwrap();
templates.render("page.html", &teractx).unwrap()
Implement a web backend for rustdoc_ng This large commit implements and `html` output option for rustdoc_ng. The executable has been altered to be invoked as "rustdoc_ng html <crate>" and it will dump everything into the local "doc" directory. JSON can still be generated by changing 'html' to 'json'. This also fixes a number of bugs in rustdoc_ng relating to comment stripping, along with some other various issues that I found along the way. The `make doc` command has been altered to generate the new documentation into the `doc/ng/$(CRATE)` directories.
2013-09-18 22:18:38 -07:00
}
Make all rustdoc functions and structs crate-private This gives warnings about dead code.
2020-11-14 17:59:58 -05:00
crate fn redirect(url: &str) -> String {
rustdoc: Preserve query/fragment in redirects whenever possible. We heavily rely on queries and fragments in the URL structure, so it is desired to preserve them even in the redirects. The generated redirect pages try to preserve them with scripts, which take precedence over the original `Refresh` metadata. Non-scripting browsers would continue to work (with no queries and fragments).
2014-12-04 12:48:16 +09:00
// <script> triggers a redirect before refresh, so this is fine.
Create buffers in top-level rendering This avoids needlessly creating and threading the buffers through when we only use them once.
2019-08-30 10:35:14 -04:00
format!(
Format the world
2019-12-22 17:42:04 -05:00
r##"<!DOCTYPE html>
rustdoc: Fix cross-crate links to reexported items Cross crate links can target items which are not rendered in the documentation. If the item is reexported at a higher level, the destination of the link (a concatenation of the fully qualified name) may actually lead to nowhere. This fixes this problem by altering rustdoc to emit pages which redirect to the local copy of the reexported structure. cc #14515 Closes #14137
2014-05-29 13:50:47 -07:00
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL={url}">
Add missing <title> in redirection page <head>
2021-04-23 17:47:50 +02:00
<title>Redirection</title>
rustdoc: Fix cross-crate links to reexported items Cross crate links can target items which are not rendered in the documentation. If the item is reexported at a higher level, the destination of the link (a concatenation of the fully qualified name) may actually lead to nowhere. This fixes this problem by altering rustdoc to emit pages which redirect to the local copy of the reexported structure. cc #14515 Closes #14137
2014-05-29 13:50:47 -07:00
</head>
<body>
rustdoc: Preserve query/fragment in redirects whenever possible. We heavily rely on queries and fragments in the URL structure, so it is desired to preserve them even in the redirects. The generated redirect pages try to preserve them with scripts, which take precedence over the original `Refresh` metadata. Non-scripting browsers would continue to work (with no queries and fragments).
2014-12-04 12:48:16 +09:00
<p>Redirecting to <a href="{url}">{url}</a>...</p>
<script>location.replace("{url}" + location.search + location.hash);</script>
rustdoc: Fix cross-crate links to reexported items Cross crate links can target items which are not rendered in the documentation. If the item is reexported at a higher level, the destination of the link (a concatenation of the fully qualified name) may actually lead to nowhere. This fixes this problem by altering rustdoc to emit pages which redirect to the local copy of the reexported structure. cc #14515 Closes #14137
2014-05-29 13:50:47 -07:00
</body>
</html>"##,
Format the world
2019-12-22 17:42:04 -05:00
url = url,
rustdoc: Fix cross-crate links to reexported items Cross crate links can target items which are not rendered in the documentation. If the item is reexported at a higher level, the destination of the link (a concatenation of the fully qualified name) may actually lead to nowhere. This fixes this problem by altering rustdoc to emit pages which redirect to the local copy of the reexported structure. cc #14515 Closes #14137
2014-05-29 13:50:47 -07:00
)
}
Reference in a new issue Copy permalink