about summary refs log tree commit diff
diff options
context:
space:
mode:
authorbors <bors@rust-lang.org>2014-08-03 17:01:06 +0000
committerbors <bors@rust-lang.org>2014-08-03 17:01:06 +0000
commitd34e011b8e4b7df4433aaf32ea42e36a577a6386 (patch)
treecc2ba341039bc1d95ce175199170df3b6e83dc73
parent8b9ab0d91243e2e616275f09410bc82018892f14 (diff)
parent9b44dfc7644978592ce7f9d4a683c552a5021cef (diff)
downloadrust-d34e011b8e4b7df4433aaf32ea42e36a577a6386.tar.gz
rust-d34e011b8e4b7df4433aaf32ea42e36a577a6386.zip
auto merge of #16209 : tomjakubowski/rust/rustdoc-html-changes, r=alexcrichton
This PR introduces a couple of minor changes to the rustdoc html templates:

1. The `<meta name="generator" content="rustdoc">` tag now appears in API documentation as well.
2. Adds a `rustdoc` class to the top-level `<body>` tag on all HTML pages.

The second point is a nice-to-have for those who would like to apply a user stylesheet to Rust documentation regardless of where it is hosted. Easier use of user stylesheets may alleviate much of the bikeshedding of personal taste on the rustdoc styles.
-rw-r--r--src/librustdoc/html/layout.rs3
-rw-r--r--src/librustdoc/markdown.rs2
2 files changed, 3 insertions, 2 deletions
diff --git a/src/librustdoc/html/layout.rs b/src/librustdoc/html/layout.rs
index 356b224e6d5..70e9d004160 100644
--- a/src/librustdoc/html/layout.rs
+++ b/src/librustdoc/html/layout.rs
@@ -39,6 +39,7 @@ r##"<!DOCTYPE html>
     <meta charset="utf-8">
     <meta name="viewport" content="width=device-width, initial-scale=1.0">
     <meta name="description" content="The {krate} library documentation.">
+    <meta name="generator" content="rustdoc">
 
     <title>{title}</title>
 
@@ -47,7 +48,7 @@ r##"<!DOCTYPE html>
     {favicon}
     {in_header}
 </head>
-<body>
+<body class="rustdoc">
     <!--[if lte IE 8]>
     <div class="warning">
         This old browser is unsupported and will most likely display funky
diff --git a/src/librustdoc/markdown.rs b/src/librustdoc/markdown.rs
index 29da9462c7f..98b902f4504 100644
--- a/src/librustdoc/markdown.rs
+++ b/src/librustdoc/markdown.rs
@@ -98,7 +98,7 @@ pub fn render(input: &str, mut output: Path, matches: &getopts::Matches,
     {css}
     {in_header}
 </head>
-<body>
+<body class="rustdoc">
     <!--[if lte IE 8]>
     <div class="warning">
         This old browser is unsupported and will most likely display funky