HTML renderer: option to omit the toc

Author: jonludlam

src/html/config.ml

@@ -8,10 +8,11 @@ type t = {
   flat : bool;
   open_details : bool;
   omit_breadcrumbs : bool;
+  omit_toc : bool;
 }
 
-let v ?theme_uri ?support_uri ~semantic_uris ~indent ~flat ~open_details ~omit_breadcrumbs () =
-  { theme_uri; support_uri; semantic_uris; indent; flat; open_details; omit_breadcrumbs }
+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 theme_uri config =
   match config.theme_uri with None -> Types.Relative None | Some uri -> uri
@@ -27,4 +28,6 @@ let flat config = config.flat
 
 let open_details config = config.open_details
 
-let omit_breadcrumbs config = config.omit_breadcrumbs
+let omit_breadcrumbs config = config.omit_breadcrumbs
+
+let omit_toc config = config.omit_toc

src/html/config.mli

@@ -10,6 +10,7 @@ val v :
   flat:bool ->
   open_details:bool ->
   omit_breadcrumbs:bool ->
+  omit_toc:bool ->
   unit ->
   t
 
@@ -26,3 +27,5 @@ val flat : t -> bool
 val open_details : t -> bool
 
 val omit_breadcrumbs : t -> bool
+
+val omit_toc : t -> bool

src/html/tree.ml

@@ -131,10 +131,11 @@ let page_creator ~config ~url name header toc content =
   in
 
   let breadcrumbs = if Config.omit_breadcrumbs config then [] else gen_breadcrumbs () in
+  let toc = if Config.omit_toc config then [] else html_of_toc toc in
   let body =
     breadcrumbs
     @ [ Html.header ~a:[ Html.a_class [ "odoc-preamble" ] ] header ]
-    @ html_of_toc toc
+    @ toc
     @ [ Html.div ~a:[ Html.a_class [ "odoc-content" ] ] content ]
   in
   Html.html head (Html.body ~a:[ Html.a_class [ "odoc" ] ] body)

src/odoc/bin/main.ml

@@ -521,15 +521,22 @@ module Odoc_html_args = struct
       "Don't emit the breadcrumbs navigation element"
     in
     Arg.(value & flag & info ~docs ~doc [ "omit-breadcrumbs"])
+
+  let omit_toc =
+    let doc = 
+      "Don't emit the table of contents div"
+    in
+    Arg.(value & flag & info ~docs ~doc [ "omit-toc"])
+  
   let extra_args =
-    let config semantic_uris closed_details indent theme_uri support_uri flat omit_breadcrumbs =
+    let config semantic_uris closed_details indent theme_uri support_uri flat omit_breadcrumbs omit_toc =
       let open_details = not closed_details in
       Odoc_html.Config.v ~theme_uri ~support_uri ~semantic_uris ~indent ~flat
-        ~open_details ~omit_breadcrumbs ()
+        ~open_details ~omit_breadcrumbs ~omit_toc ()
     in
     Term.(
       const config $ semantic_uris $ closed_details $ indent $ theme_uri
-      $ support_uri $ flat $ omit_breadcrumbs)
+      $ support_uri $ flat $ omit_breadcrumbs $ omit_toc)
 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 ()
+        ~open_details:false ~omit_breadcrumbs:false ~omit_toc: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

@@ -32,5 +32,12 @@ Check semantic_uris:
   $ grep Test.t html/test/Test2/index.html
          <a href="../Test/#type-t">Test.t</a>
 
+Check omission of toc:
+  $ odoc html-generate test.odocl -o html --indent
+  $ grep odoc-toc html/test/Test/index.html
+    <nav class="odoc-toc">
+  $ odoc html-generate test.odocl -o html --indent --omit-toc
+  $ grep odoc-toc html/test/Test/index.html
+  [1]