enable mathjax support in rustdoc

Gankra · Gankra · commit d65092a7b537 · 2014-09-04T14:18:56.000-04:00
diff --git a/src/librustdoc/html/layout.rs b/src/librustdoc/html/layout.rs
@@ -20,6 +20,7 @@ pub struct Layout {
     pub external_html: ExternalHtml,
     pub krate: String,
     pub playground_url: String,
+    pub use_mathjax: bool,
 }
 
 pub struct Page<'a> {
@@ -124,6 +125,7 @@ r##"<!DOCTYPE html>
     <script src="{root_path}main.js"></script>
     {play_js}
     <script async src="{root_path}search-index.js"></script>
+    {mathjax_js}
 </body>
 </html>"##,
     content   = *t,
@@ -156,6 +158,12 @@ r##"<!DOCTYPE html>
     } else {
         format!(r#"<script src="{}playpen.js"></script>"#, page.root_path)
     },
+    mathjax_js = if layout.use_mathjax {
+        r#"<script async src="//cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS_HTML">
+        </script>"#.to_string()
+    } else {
+        "".to_string()
+    },
     )
 }
 
diff --git a/src/librustdoc/html/markdown.rs b/src/librustdoc/html/markdown.rs
@@ -56,6 +56,7 @@ static HOEDOWN_EXT_AUTOLINK: libc::c_uint = 1 << 3;
 static HOEDOWN_EXT_STRIKETHROUGH: libc::c_uint = 1 << 4;
 static HOEDOWN_EXT_SUPERSCRIPT: libc::c_uint = 1 << 8;
 static HOEDOWN_EXT_FOOTNOTES: libc::c_uint = 1 << 2;
+static HOEDOWN_EXT_MATH: libc::c_uint = 1 << 13;
 
 static HOEDOWN_EXTENSIONS: libc::c_uint =
     HOEDOWN_EXT_NO_INTRA_EMPHASIS | HOEDOWN_EXT_TABLES |
@@ -147,10 +148,22 @@ fn stripped_filtered_line<'a>(s: &'a str) -> Option<&'a str> {
     }
 }
 
+fn hoedown_extensions() -> libc::c_uint {
+    let mut extensions = HOEDOWN_EXTENSIONS;
+
+    match use_mathjax.get().as_ref() {
+        Some(use_math) if **use_math => { extensions |= HOEDOWN_EXT_MATH; }
+        _ => {}
+    }
+
+    extensions
+}
+
 local_data_key!(used_header_map: RefCell<HashMap<String, uint>>)
 local_data_key!(test_idx: Cell<uint>)
 // None == render an example, but there's no crate name
 local_data_key!(pub playground_krate: Option<String>)
+local_data_key!(pub use_mathjax: bool)
 
 pub fn render(w: &mut fmt::Formatter, s: &str, print_toc: bool) -> fmt::Result {
     extern fn block(ob: *mut hoedown_buffer, text: *const hoedown_buffer,
@@ -285,7 +298,7 @@ pub fn render(w: &mut fmt::Formatter, s: &str, print_toc: bool) -> fmt::Result {
         (*renderer).blockcode = Some(block);
         (*renderer).header = Some(header);
 
-        let document = hoedown_document_new(renderer, HOEDOWN_EXTENSIONS, 16);
+        let document = hoedown_document_new(renderer, hoedown_extensions(), 16);
         hoedown_document_render(document, ob, s.as_ptr(),
                                 s.len() as libc::size_t);
         hoedown_document_free(document);
@@ -363,7 +376,7 @@ pub fn find_testable_code(doc: &str, tests: &mut ::test::Collector) {
         (*renderer).header = Some(header);
         (*(*renderer).opaque).opaque = tests as *mut _ as *mut libc::c_void;
 
-        let document = hoedown_document_new(renderer, HOEDOWN_EXTENSIONS, 16);
+        let document = hoedown_document_new(renderer, hoedown_extensions(), 16);
         hoedown_document_render(document, ob, doc.as_ptr(),
                                 doc.len() as libc::size_t);
         hoedown_document_free(document);
diff --git a/src/librustdoc/html/render.rs b/src/librustdoc/html/render.rs
@@ -245,11 +245,14 @@ pub fn run(mut krate: clean::Crate, external_html: &ExternalHtml, dst: Path) ->
             external_html: external_html.clone(),
             krate: krate.name.clone(),
             playground_url: "".to_string(),
+            use_mathjax: false,
         },
         include_sources: true,
         render_redirect_pages: false,
     };
 
+    markdown::use_mathjax.replace(None);
+
     try!(mkdir(&cx.dst));
 
     // Crawl the crate, building a summary of the stability levels.  NOTE: this
@@ -284,6 +287,11 @@ pub fn run(mut krate: clean::Crate, external_html: &ExternalHtml, dst: Path) ->
                             if "html_no_source" == x.as_slice() => {
                         cx.include_sources = false;
                     }
+                    clean::Word(ref x)
+                            if "enable_mathjax" == x.as_slice() => {
+                        cx.layout.use_mathjax = true;
+                        markdown::use_mathjax.replace(Some(true));
+                    }
                     _ => {}
                 }
             }
