HTML renderer: option to omit breadcrumbs

Author: jonludlam

src/html/config.ml

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

src/html/config.mli

@@ -9,6 +9,7 @@ val v :
   indent:bool ->
   flat:bool ->
   open_details:bool ->
+  omit_breadcrumbs:bool ->
   unit ->
   t
 
@@ -23,3 +24,5 @@ val indent : t -> bool
 val flat : t -> bool
 
 val open_details : t -> bool
+
+val omit_breadcrumbs : t -> bool

src/html/tree.ml

@@ -72,7 +72,7 @@ let page_creator ~config ~url name header toc content =
       ]
   in
 
-  let breadcrumbs =
+  let gen_breadcrumbs () =
     let rec get_parents x =
       match x with
       | [] -> []
@@ -130,6 +130,7 @@ let page_creator ~config ~url name header toc content =
         make_navigation ~up_url l
   in
 
+  let breadcrumbs = if Config.omit_breadcrumbs config then [] else gen_breadcrumbs () in
   let body =
     breadcrumbs
     @ [ Html.header ~a:[ Html.a_class [ "odoc-preamble" ] ] header ]

src/odoc/bin/main.ml

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

@@ -27,3 +27,7 @@
  (libraries sexplib0 unix fpath)
  (enabled_if
   (>= %{ocaml_version} 4.04)))
+
+(cram
+ (deps %{bin:odoc}))
+

test/generators/html_opts.t/run.t

@@ -0,0 +1,36 @@
+  $ ocamlc -c -bin-annot test.mli
+  $ ocamlc -c -bin-annot test2.mli
+  $ odoc compile --package test test.cmti
+  $ odoc compile --package test -I . test2.cmti
+  $ odoc link test.odoc
+  $ odoc link test2.odoc
+  $ odoc html-generate test.odocl -o html --indent
+
+This should have the breadcrumbs in it as a nav with id 'odoc-nav'. Let's also
+check it's got the expected content by looking for 'type-t'
+
+  $ grep odoc-nav html/test/Test/index.html
+    <nav class="odoc-nav"><a href="../index.html">Up</a> – 
+  $ grep type-t html/test/Test/index.html
+      <div class="spec type anchored" id="type-t">
+       <a href="#type-t" class="anchor"></a>
+
+Generate again, this time omitting the breadcrumbs:
+
+  $ odoc html-generate test.odocl -o html --omit-breadcrumbs --indent
+  $ grep odoc-nav html/test/Test/index.html
+  [1]
+  $ grep type-t html/test/Test/index.html
+      <div class="spec type anchored" id="type-t">
+       <a href="#type-t" class="anchor"></a>
+
+Check semantic_uris:
+  $ odoc html-generate test2.odocl -o html --indent
+  $ grep Test.t html/test/Test2/index.html
+         <a href="../Test/index.html#type-t">Test.t</a>
+  $ odoc html-generate test2.odocl -o html --semantic-uris --indent
+  $ grep Test.t html/test/Test2/index.html
+         <a href="../Test/#type-t">Test.t</a>
+
+
+

test/generators/html_opts.t/test.mli

@@ -0,0 +1,10 @@
+(** Test *)
+
+(** {1 Section 1} *)
+
+type t
+
+(** {1 Section 2} *)
+
+type u
+

test/generators/html_opts.t/test2.mli

@@ -0,0 +1,3 @@
+val v : Test.t
+
+