HTML renderer: option to output content only

Author: jonludlam

src/html/config.ml

@@ -9,10 +9,11 @@ type t = {
   open_details : bool;
   omit_breadcrumbs : bool;
   omit_toc : bool;
+  content_only : bool;
 }
 
-let v ?theme_uri ?support_uri ~semantic_uris ~indent ~flat ~open_details ~omit_breadcrumbs ~omit_toc () =
-  { theme_uri; support_uri; semantic_uris; indent; flat; open_details; omit_breadcrumbs; omit_toc }
+let v ?theme_uri ?support_uri ~semantic_uris ~indent ~flat ~open_details ~omit_breadcrumbs ~omit_toc ~content_only () =
+  { theme_uri; support_uri; semantic_uris; indent; flat; open_details; omit_breadcrumbs; omit_toc; content_only }
 
 let theme_uri config =
   match config.theme_uri with None -> Types.Relative None | Some uri -> uri
@@ -30,4 +31,6 @@ let open_details config = config.open_details
 
 let omit_breadcrumbs config = config.omit_breadcrumbs
 
-let omit_toc config = config.omit_toc
+let omit_toc config = config.omit_toc
+
+let content_only config = config.content_only

src/html/config.mli

@@ -11,6 +11,7 @@ val v :
   open_details:bool ->
   omit_breadcrumbs:bool ->
   omit_toc:bool ->
+  content_only:bool ->
   unit ->
   t
 
@@ -28,4 +29,6 @@ val open_details : t -> bool
 
 val omit_breadcrumbs : t -> bool
 
-val omit_toc : t -> bool
+val omit_toc : t -> bool
+
+val content_only : t -> bool

src/html/tree.ml

@@ -138,10 +138,19 @@ let page_creator ~config ~url name header toc content =
     @ toc
     @ [ Html.div ~a:[ Html.a_class [ "odoc-content" ] ] content ]
   in
-  Html.html head (Html.body ~a:[ Html.a_class [ "odoc" ] ] body)
+  let htmlpp_elt = Html.pp_elt ~indent:(Config.indent config) () in
+  let htmlpp = Html.pp ~indent:(Config.indent config) () in
+  if Config.content_only config
+  then begin
+    let content ppf = htmlpp_elt ppf (Html.div ~a:[ Html.a_class [ "odoc" ] ] body) in
+    content
+  end else begin
+    let html = Html.html head (Html.body ~a:[ Html.a_class [ "odoc" ] ] body) in
+    let content ppf = htmlpp ppf html in
+    content
+  end
 
 let make ~config ~url ~header ~toc title content children =
   let filename = Link.Path.as_filename ~is_flat:(Config.flat config) url in
-  let html = page_creator ~config ~url title header toc content in
-  let content ppf = (Html.pp ~indent:(Config.indent config) ()) ppf html in
+  let content = page_creator ~config ~url title header toc content in
   [ { Odoc_document.Renderer.filename; content; children } ]

src/odoc/bin/main.ml

@@ -527,16 +527,22 @@ module Odoc_html_args = struct
       "Don't emit the table of contents div"
     in
     Arg.(value & flag & info ~docs ~doc [ "omit-toc"])
+
+  let content_only =
+    let doc = 
+      "Only emit the content of the page, not the html, head and body elements"
+    in
+    Arg.(value & flag & info ~docs ~doc [ "content-only"])
 
   let extra_args =
-    let config semantic_uris closed_details indent theme_uri support_uri flat omit_breadcrumbs omit_toc =
+    let config semantic_uris closed_details indent theme_uri support_uri flat omit_breadcrumbs omit_toc content_only =
       let open_details = not closed_details in
       Odoc_html.Config.v ~theme_uri ~support_uri ~semantic_uris ~indent ~flat
-        ~open_details ~omit_breadcrumbs ~omit_toc ()
+        ~open_details ~omit_breadcrumbs ~omit_toc ~content_only ()
     in
     Term.(
       const config $ semantic_uris $ closed_details $ indent $ theme_uri
-      $ support_uri $ flat $ omit_breadcrumbs $ omit_toc)
+      $ support_uri $ flat $ omit_breadcrumbs $ omit_toc $ content_only)
 end
 
 module Odoc_html = Make_renderer (Odoc_html_args)

src/odoc/html_fragment.ml

@@ -26,7 +26,7 @@ let from_mld ~xref_base_uri ~resolver ~output ~warnings_options input =
     let page = Odoc_document.Comment.to_ir resolved.content in
     let config =
       Odoc_html.Config.v ~semantic_uris:false ~indent:false ~flat:false
-        ~open_details:false ~omit_breadcrumbs:false ~omit_toc:false ()
+        ~open_details:false ~omit_breadcrumbs:false ~omit_toc:false ~content_only:false ()
     in
     let html = Odoc_html.Generator.doc ~config ~xref_base_uri page in
     let oc = open_out (Fs.File.to_string output) in

test/generators/html_opts.t/run.t

@@ -40,4 +40,9 @@ Check omission of toc:
   $ grep odoc-toc html/test/Test/index.html
   [1]
 
+Check content-only output:
+  $ odoc html-generate test.odocl -o html --indent --content-only
+  $ head -n 1 html/test/Test/index.html
+  <div class="odoc">
+