diff options
| author | Guillaume Gomez <guillaume1.gomez@gmail.com> | 2018-01-20 22:16:46 +0100 |
|---|---|---|
| committer | Guillaume Gomez <guillaume1.gomez@gmail.com> | 2018-01-21 17:35:35 +0100 |
| commit | 9aee164a8eb39aa17fef8e1d433c8474febe61f7 (patch) | |
| tree | df350bb560bb8a973b080556e8c01b6e3b9791d1 | |
| parent | 003b2bc1c65251ec2fc80b78ed91c43fb35402ec (diff) | |
| download | rust-9aee164a8eb39aa17fef8e1d433c8474febe61f7.tar.gz rust-9aee164a8eb39aa17fef8e1d433c8474febe61f7.zip | |
Add themes option
| -rw-r--r-- | src/librustdoc/externalfiles.rs | 2 | ||||
| -rw-r--r-- | src/librustdoc/html/render.rs | 35 | ||||
| -rw-r--r-- | src/librustdoc/lib.rs | 17 |
3 files changed, 41 insertions, 13 deletions
diff --git a/src/librustdoc/externalfiles.rs b/src/librustdoc/externalfiles.rs index f8320330ad2..420e0b2e807 100644 --- a/src/librustdoc/externalfiles.rs +++ b/src/librustdoc/externalfiles.rs @@ -14,7 +14,7 @@ use std::str; use html::markdown::{Markdown, RenderType}; #[derive(Clone)] -pub struct ExternalHtml{ +pub struct ExternalHtml { /// Content that will be included inline in the <head> section of a /// rendered Markdown file or generated documentation pub in_header: String, diff --git a/src/librustdoc/html/render.rs b/src/librustdoc/html/render.rs index 007d663cf94..95db6a8679e 100644 --- a/src/librustdoc/html/render.rs +++ b/src/librustdoc/html/render.rs @@ -132,6 +132,8 @@ pub struct SharedContext { /// This flag indicates whether listings of modules (in the side bar and documentation itself) /// should be ordered alphabetically or in order of appearance (in the source code). pub sort_modules_alphabetically: bool, + /// Additional themes to be added to the generated docs. + pub themes: Vec<PathBuf>, } impl SharedContext { @@ -500,7 +502,8 @@ pub fn run(mut krate: clean::Crate, renderinfo: RenderInfo, render_type: RenderType, sort_modules_alphabetically: bool, - deny_render_differences: bool) -> Result<(), Error> { + deny_render_differences: bool, + themes: Vec<PathBuf>) -> Result<(), Error> { let src_root = match krate.src { FileName::Real(ref p) => match p.parent() { Some(p) => p.to_path_buf(), @@ -524,6 +527,7 @@ pub fn run(mut krate: clean::Crate, markdown_warnings: RefCell::new(vec![]), created_dirs: RefCell::new(FxHashSet()), sort_modules_alphabetically, + themes, }; // If user passed in `--playground-url` arg, we fill in crate name here @@ -872,19 +876,28 @@ fn write_shared(cx: &Context, write(cx.dst.join("rustdoc.css"), include_bytes!("static/rustdoc.css"))?; - let path = cx.shared.src_root.join("../librustdoc/html/static/themes"); - let mut themes: Vec<String> = Vec::new(); - for entry in try_err!(fs::read_dir(path.clone()), &path) { - let entry = try_err!(entry, &path); + + // To avoid "main.css" to be overwritten, we'll first run over the received themes and only + // then we'll run over the "official" styles. + let mut themes: HashSet<String> = HashSet::new(); + + for entry in &cx.shared.themes { let mut content = Vec::with_capacity(100000); - let mut f = try_err!(File::open(entry.path()), &entry.path()); - try_err!(f.read_to_end(&mut content), &entry.path()); - write(cx.dst.join(entry.file_name()), content.as_slice())?; - themes.push(try_none!( - try_none!(entry.path().file_stem(), &entry.path()).to_str(), - &entry.path()).to_owned()); + let mut f = try_err!(File::open(&entry), &entry); + try_err!(f.read_to_end(&mut content), &entry); + write(cx.dst.join(try_none!(entry.file_name(), &entry)), content.as_slice())?; + themes.insert(try_none!(try_none!(entry.file_stem(), &entry).to_str(), &entry).to_owned()); } + + write(cx.dst.join("main.css"), + include_bytes!("static/themes/main.css"))?; + themes.insert("main".to_owned()); + write(cx.dst.join("dark.css"), + include_bytes!("static/themes/dark.css"))?; + themes.insert("dark".to_owned()); + + let mut themes: Vec<&String> = themes.iter().collect(); themes.sort(); // To avoid theme switch latencies as much as possible, we put everything theme related // at the beginning of the html files into another js file. diff --git a/src/librustdoc/lib.rs b/src/librustdoc/lib.rs index 2e2dba7681c..bf624c31d3d 100644 --- a/src/librustdoc/lib.rs +++ b/src/librustdoc/lib.rs @@ -264,6 +264,11 @@ pub fn opts() -> Vec<RustcOptGroup> { o.optflag("", "deny-render-differences", "abort doc runs when markdown rendering \ differences are found") }), + unstable("themes", |o| { + o.optmulti("", "themes", + "additional themes which will be added to the generated docs", + "FILES") + }), ] } @@ -365,6 +370,15 @@ pub fn main_args(args: &[String]) -> isize { } } + let mut themes = Vec::new(); + for theme in matches.opt_strs("themes").iter().map(|s| PathBuf::from(&s)) { + if !theme.is_file() { + eprintln!("rustdoc: option --themes arguments must all be files"); + return 1; + } + themes.push(theme); + } + let external_html = match ExternalHtml::load( &matches.opt_strs("html-in-header"), &matches.opt_strs("html-before-content"), @@ -413,7 +427,8 @@ pub fn main_args(args: &[String]) -> isize { renderinfo, render_type, sort_modules_alphabetically, - deny_render_differences) + deny_render_differences, + themes) .expect("failed to generate documentation"); 0 } |