Allow multiple search assets

Signed-off-by: Paul-Elliot <[email protected]>

Author: panglesd

src/document/generator.ml

@@ -86,10 +86,10 @@ let prepare_preamble comment items =
   in
   (Comment.standalone preamble, Comment.standalone first_comment @ items)
 
-let make_expansion_page ~source_anchor ~search_asset url comments items =
+let make_expansion_page ~source_anchor ~search_assets url comments items =
   let comment = List.concat comments in
   let preamble, items = prepare_preamble comment items in
-  { Page.preamble; items; url; source_anchor; search_asset }
+  { Page.preamble; items; url; source_anchor; search_assets }
 
 include Generator_signatures
 
@@ -1105,7 +1105,7 @@ module Make (Syntax : SYNTAX) = struct
             let expansion_doc, items = class_signature csig in
             let url = Url.Path.from_identifier t.id in
             let page =
-              make_expansion_page ~search_asset:None ~source_anchor url
+              make_expansion_page ~search_assets:[] ~source_anchor url
                 [ t.doc; expansion_doc ] items
             in
             ( O.documentedSrc @@ path url [ inline @@ Text name ],
@@ -1143,7 +1143,7 @@ module Make (Syntax : SYNTAX) = struct
             let url = Url.Path.from_identifier t.id in
             let expansion_doc, items = class_signature csig in
             let page =
-              make_expansion_page ~search_asset:None ~source_anchor url
+              make_expansion_page ~search_assets:[] ~source_anchor url
                 [ t.doc; expansion_doc ] items
             in
             ( O.documentedSrc @@ path url [ inline @@ Text name ],
@@ -1270,7 +1270,7 @@ module Make (Syntax : SYNTAX) = struct
             let modname = path url [ inline @@ Text name ] in
             let type_with_expansion =
               let content =
-                make_expansion_page ~search_asset:None ~source_anchor:None url
+                make_expansion_page ~search_assets:[] ~source_anchor:None url
                   [ expansion_doc ] items
               in
               let summary = O.render modtyp in
@@ -1411,7 +1411,7 @@ module Make (Syntax : SYNTAX) = struct
             let url = Url.Path.from_identifier t.id in
             let link = path url [ inline @@ Text modname ] in
             let page =
-              make_expansion_page ~search_asset:None ~source_anchor url
+              make_expansion_page ~search_assets:[] ~source_anchor url
                 [ t.doc; expansion_doc ] items
             in
             (link, status, Some page, Some expansion_doc)
@@ -1472,7 +1472,7 @@ module Make (Syntax : SYNTAX) = struct
             let url = Url.Path.from_identifier id in
             let link = path url [ inline @@ Text modname ] in
             let page =
-              make_expansion_page ~search_asset:None ~source_anchor url
+              make_expansion_page ~search_assets:[] ~source_anchor url
                 [ doc; expansion_doc ] items
             in
             (link, Some page, Some expansion_doc)
@@ -1762,14 +1762,16 @@ module Make (Syntax : SYNTAX) = struct
         | Some src -> Some (Source_page.url src.id)
         | None -> None
       in
-      let search_asset =
-        match t.search_asset with
-        | Some (`Resolved (`Identifier id)) ->
-            Some (Url.Path.from_identifier id)
-        | _ -> None
+      let search_assets =
+        List.filter_map
+          (function
+            | `Resolved (`Identifier id) ->
+                Some Url.(from_path @@ Path.from_identifier id)
+            | _ -> None)
+          t.search_assets
       in
       let page =
-        make_expansion_page ~search_asset ~source_anchor url [ unit_doc ] items
+        make_expansion_page ~search_assets ~source_anchor url [ unit_doc ] items
       in
       Document.Page page
 
@@ -1782,7 +1784,7 @@ module Make (Syntax : SYNTAX) = struct
       let preamble, items = Sectioning.docs t.content in
       let source_anchor = None in
       Document.Page
-        { Page.preamble; items; url; source_anchor; search_asset = None }
+        { Page.preamble; items; url; source_anchor; search_assets = [] }
 
     let source_tree t =
       let dir_pages = t.Odoc_model.Lang.SourceTree.source_children in
@@ -1872,7 +1874,7 @@ module Make (Syntax : SYNTAX) = struct
             items;
             url;
             source_anchor = None;
-            search_asset = None;
+            search_assets = [];
           }
       in
       M.fold (fun dir children acc -> page_of_dir dir children :: acc) mmap []

src/document/types.ml

@@ -178,7 +178,7 @@ and Page : sig
     source_anchor : Url.t option;
         (** Url to the corresponding source code. Might be a whole source file
             or a sub part. *)
-    search_asset : Url.Path.t option;
+    search_assets : Url.t list;
   }
 end =
   Page

src/html/generator.ml

@@ -476,7 +476,7 @@ module Page = struct
   and subpages ~config subpages = List.map (include_ ~config) subpages
 
   and page ~config p : Odoc_document.Renderer.page =
-    let { Page.preamble; items = i; url; source_anchor; search_asset } =
+    let { Page.preamble; items = i; url; source_anchor; search_assets } =
       Doctree.Labels.disambiguate_page ~enter_subpages:false p
     in
     let subpages = subpages ~config @@ Doctree.Subpages.compute p in
@@ -485,12 +485,7 @@ module Page = struct
     let uses_katex = Doctree.Math.has_math_elements p in
     let toc = Toc.gen_toc ~config ~resolve ~path:url i in
     let breadcrumbs = Breadcrumbs.gen_breadcrumbs ~config ~url in
-    let search_url =
-      match search_asset with
-      | Some url ->
-          Some (Link.href ~config ~resolve (Odoc_document.Url.from_path url))
-      | None -> None
-    in
+    let search_urls = List.map (Link.href ~config ~resolve) search_assets in
     let content = (items ~config ~resolve i :> any Html.elt list) in
     if Config.as_json config then
       let source_anchor =
@@ -507,7 +502,7 @@ module Page = struct
           (Doctree.PageTitle.render_title ?source_anchor p @ preamble)
       in
       Html_page.make ~config ~header ~toc ~breadcrumbs ~url ~uses_katex
-        ~search_url content subpages
+        ~search_urls content subpages
 
   and source_page ~config sp =
     let { Source_page.url; contents } = sp in

src/html/html_page.ml

@@ -94,7 +94,7 @@ let html_of_breadcrumbs (breadcrumbs : Types.breadcrumb list) =
       make_navigation ~up_url:up.href
         (List.rev html @ sep @ [ Html.txt current.name ])
 
-let page_creator ~config ~url ~uses_katex ~search_url header breadcrumbs toc
+let page_creator ~config ~url ~uses_katex ~search_urls header breadcrumbs toc
     content =
   let theme_uri = Config.theme_uri config in
   let support_uri = Config.support_uri config in
@@ -115,10 +115,16 @@ let page_creator ~config ~url ~uses_katex ~search_url header breadcrumbs toc
     let odoc_css_uri = file_uri theme_uri "odoc.css" in
     let highlight_js_uri = file_uri support_uri "highlight.pack.js" in
     let search_scripts =
-      match search_url with
-      | None -> []
-      | Some search_url ->
-          let search_urls = "['" ^ search_url ^ "']" in
+      match search_urls with
+      | [] -> []
+      | search_urls ->
+          let search_urls =
+            let search_url name =
+              Printf.sprintf "'%s'" (file_uri support_uri name)
+            in
+            let search_urls = List.map search_url search_urls in
+            "[" ^ String.concat "," search_urls ^ "]"
+          in
           [
             Html.script ~a:[]
               (Html.txt
@@ -187,10 +193,10 @@ let page_creator ~config ~url ~uses_katex ~search_url header breadcrumbs toc
     Html.head (Html.title (Html.txt title_string)) meta_elements
   in
   let search_bar =
-    match search_url with
-    | Some _ ->
+    match search_urls with
+    | [] -> []
+    | _ ->
         [ Html.div ~a:[ Html.a_class [ "odoc-search" ] ] [ html_of_search () ] ]
-    | None -> []
   in
 
   let body =
@@ -210,11 +216,11 @@ let page_creator ~config ~url ~uses_katex ~search_url header breadcrumbs toc
   in
   content
 
-let make ~config ~url ~header ~breadcrumbs ~toc ~uses_katex ~search_url content
+let make ~config ~url ~header ~breadcrumbs ~toc ~uses_katex ~search_urls content
     children =
   let filename = Link.Path.as_filename ~is_flat:(Config.flat config) url in
   let content =
-    page_creator ~config ~url ~uses_katex ~search_url header breadcrumbs toc
+    page_creator ~config ~url ~uses_katex ~search_urls header breadcrumbs toc
       content
   in
   { Odoc_document.Renderer.filename; content; children }

src/html/html_page.mli

@@ -27,7 +27,7 @@ val make :
   breadcrumbs:Types.breadcrumb list ->
   toc:Types.toc list ->
   uses_katex:bool ->
-  search_url:string option ->
+  search_urls:string list ->
   Html_types.div_content Html.elt list ->
   Odoc_document.Renderer.page list ->
   Odoc_document.Renderer.page