odoc: handle .mld files

src/gen_rules.ml

@@ -627,7 +627,13 @@ Add it to your jbuild file to remove this warning.
       );
 
     (* Odoc *)
-    Odoc.setup_library_rules sctx lib ~dir ~requires ~modules ~dep_graph;
+    let mld_files =
+      String_set.fold files ~init:[] ~f:(fun fn acc ->
+        if Filename.check_suffix fn ".mld" then fn :: acc else acc)
+    in
+    Odoc.setup_library_rules sctx lib ~dir ~requires ~modules ~dep_graph
+      ~mld_files
+    ;
 
     let flags =
       match alias_module with

src/odoc.ml

@@ -9,113 +9,141 @@ let ( ++ ) = Path.relative
 let get_odoc sctx = SC.resolve_program sctx "odoc" ~hint:"opam install odoc"
 let odoc_ext = ".odoc"
 
-let module_deps (m : Module.t) ~dir ~dep_graph ~modules =
+module Mld = struct
+  type t = {
+    name : string; (** source file name without the extension. *)
+    odoc_input_name : string;
+    odoc_file_name  : string;
+  }
+
+  let odoc_file ~dir {odoc_file_name; _} =
+    Path.relative dir odoc_file_name
+
+  let odoc_input ~dir {odoc_input_name; _} =
+    Path.relative dir odoc_input_name
+end
+
+module Module_or_mld = struct
+  type t =
+    | Mld of Mld.t
+    | Module of Module.t
+
+  let odoc_file ~dir = function
+    | Mld m -> Mld.odoc_file ~dir m
+    | Module m -> Module.odoc_file ~dir m
+
+  let odoc_input ~dir = function
+    | Mld m -> Mld.odoc_input ~dir m
+    | Module m -> Module.cmti_file m ~dir
+end
+
+let module_or_mld_deps (m : Module_or_mld.t) ~dir ~dep_graph ~modules =
   Build.dyn_paths
     (dep_graph
      >>^ fun graph ->
-     List.map (Utils.find_deps ~dir graph m.name)
+     match m with
-       ~f:(fun name ->
+     | Mld _ -> []
-         let m = Utils.find_module ~dir modules name in
+     | Module m ->
-         Module.odoc_file m ~dir))
+       List.map (Utils.find_deps ~dir graph m.name)
+         ~f:(fun name ->
+           let m = Utils.find_module ~dir modules name in
+           Module.odoc_file m ~dir))
 
-let compile_module sctx (m : Module.t) ~odoc ~dir ~includes ~dep_graph ~modules
+let compile sctx (m : Module_or_mld.t) ~odoc ~dir ~includes ~dep_graph
-      ~lib_unique_name =
+      ~modules ~lib_unique_name =
   let context = SC.context sctx in
-  let odoc_file = Module.odoc_file m ~dir in
+  let odoc_file = Module_or_mld.odoc_file m ~dir in
   SC.add_rule sctx
-    (module_deps m ~dir ~dep_graph ~modules
+    (module_or_mld_deps m ~dir ~dep_graph ~modules
      >>>
      includes
      >>>
      Build.run ~context ~dir odoc ~extra_targets:[odoc_file]
        [ A "compile"
-       ; Dyn (fun x -> x)
        ; A "-I"; Path dir
+       ; Dyn (fun x -> x)
        ; As ["--pkg"; lib_unique_name]
-       ; Dep (Module.cmti_file m ~dir)
+       ; A "-o"; Path odoc_file
+       ; Dep (Module_or_mld.odoc_input m ~dir)
        ]);
   (m, odoc_file)
 
-let to_html sctx (m : Module.t) odoc_file ~doc_dir ~odoc ~dir ~includes
+let to_html sctx (m : Module_or_mld.t) odoc_file ~doc_dir ~odoc ~dir ~includes
       ~lib_unique_name ~(lib : Library.t) =
   let context = SC.context sctx in
-  let html_dir = doc_dir ++ lib_unique_name ++ String.capitalize_ascii m.obj_name in
+  let to_remove, html_dir, html_file, jbuilder_keep =
-  let html_file = html_dir ++ "index.html" in
+    match m with
-  SC.add_rule sctx
+    | Mld m ->
-    (SC.Libs.static_file_deps (dir, lib) ~ext:odoc_ext
+      let html_dir = doc_dir ++ lib_unique_name in
-     >>>
+      let html_file = html_dir ++ (m.Mld.name ^ ".html") in
-     includes
+      html_file, html_dir, html_file, []
-     >>>
+    | Module m ->
-     Build.progn
+      let html_dir = doc_dir ++ lib_unique_name ++ String.capitalize_ascii m.obj_name in
-       [ Build.remove_tree html_dir
+      let html_file = html_dir ++ "index.html" in
-       ; Build.mkdir html_dir
+      let jbuilder_keep =
-       ; Build.run ~context ~dir odoc ~extra_targets:[html_file]
+       Build.create_file (html_dir ++ Config.jbuilder_keep_fname)
-           [ A "html"
+      in
-           ; Dyn (fun x -> x)
+      html_dir, html_dir, html_file, [jbuilder_keep]
-           ; A "-I"; Path dir
-           ; A "-o"; Path doc_dir
-           ; Dep odoc_file
-           ]
-       ; Build.create_file (html_dir ++ Config.jbuilder_keep_fname)
-       ]
-    );
-  html_file
-
-let lib_index sctx ~odoc ~dir ~(lib : Library.t) ~lib_name ~lib_unique_name ~doc_dir ~modules
-      ~includes =
-  let context = SC.context sctx in
-  let generated_index_mld = dir ++ sprintf "%s-generated.mld" lib.name in
-  let source_index_mld = dir ++ sprintf "%s.mld" lib.name in
-  let header = "{{: ../index.html} Up}" in
-  SC.add_rule sctx
-    (Build.if_file_exists source_index_mld
-       ~then_:(Build.contents source_index_mld
-               >>^ fun s -> sprintf "%s\n%s" header s)
-       ~else_:(Build.arr (fun () ->
-         (if lib.wrapped then
-            sprintf
-              "%s\n\
-               {2 Library %s}\n\
-               The entry point for this library is module {!module:%s}."
-              header
-              lib_name
-              (String.capitalize_ascii lib.name)
-          else
-            sprintf
-              "%s\n\
-               {2 Library %s}\n\
-               This library exposes the following toplevel modules:\n{!modules:%s}"
-              header
-              lib_name
-              (String_map.keys modules |> String.concat ~sep:" "))))
-     >>>
-     Build.write_file_dyn generated_index_mld);
-  let html_file =
-    doc_dir ++ lib_unique_name ++ "index.html"
   in
   SC.add_rule sctx
     (SC.Libs.static_file_deps (dir, lib) ~ext:odoc_ext
      >>>
      includes
      >>>
-     Build.run ~context ~dir odoc ~extra_targets:[html_file]
+     Build.progn (
-       [ A "html"
+       Build.remove_tree to_remove
-       ; Dyn (fun x -> x)
+       :: Build.mkdir html_dir
-       ; A "-I"; Path dir
+       :: Build.run ~context ~dir odoc ~extra_targets:[html_file]
-       ; A "-o"; Path doc_dir
+            [ A "html"
-       ; A "--index-for"; A lib_unique_name
+            ; A "-I"; Path dir
-       ; Dep generated_index_mld
+            ; Dyn (fun x -> x)
-       ]);
+            ; A "-o"; Path doc_dir
+            ; Dep odoc_file
+            ]
+       :: jbuilder_keep
+     )
+    );
   html_file
 
+let all_mld_files sctx ~(lib : Library.t) ~lib_name ~modules ~dir files =
+  let all_files =
+    if List.mem "index.mld" ~set:files then files else "index.mld" :: files
+  in
+  List.map all_files ~f:(fun file ->
+    let name = Filename.chop_extension file in
+    let odoc_input_name = sprintf "%s-generated.mld" name in
+    let odoc_file_name = sprintf "page-%s%s" name odoc_ext in
+    let generated_mld = dir ++ odoc_input_name in
+    let source_mld = dir ++ file in
+    SC.add_rule sctx
+      (Build.if_file_exists source_mld
+         ~then_:(Build.contents source_mld)
+         ~else_:(Build.arr (fun () ->
+           (if lib.wrapped then
+              sprintf
+                "{1 Library %s}\n\
+                 The entry point for this library is module {!module:%s}."
+                lib_name
+                (String.capitalize_ascii lib.name)
+            else
+              sprintf
+                "{1 Library %s}\n\
+                 This library exposes the following toplevel modules: {!modules:%s}."
+                lib_name
+                (String_map.keys modules |> String.concat ~sep:" "))))
+       >>>
+       Build.write_file_dyn generated_mld);
+    { Mld. name; odoc_file_name; odoc_input_name }
+  )
+
 let doc_dir ~context = Path.relative context.Context.build_dir "_doc"
 
 let css_file ~doc_dir = doc_dir ++ "odoc.css"
 
 let toplevel_index ~doc_dir = doc_dir ++ "index.html"
 
-let setup_library_rules sctx (lib : Library.t) ~dir ~modules ~requires
+let setup_library_rules sctx (lib : Library.t) ~dir ~modules ~mld_files
-      ~(dep_graph:Ocamldep.dep_graph) =
+      ~requires ~(dep_graph:Ocamldep.dep_graph) =
   let lib_unique_name = SC.unique_library_name sctx (Internal (dir, lib)) in
   let lib_name = Library.best_name lib in
   let context = SC.context sctx in
@@ -139,36 +167,40 @@ let setup_library_rules sctx (lib : Library.t) ~dir ~modules ~requires
        SC.Libs.file_deps sctx ~ext:odoc_ext
        >>^ Lib.include_flags)
   in
-  let modules_and_odoc_files =
+  let mld_files =
-    List.map (String_map.values modules)
+    all_mld_files sctx ~dir ~lib ~lib_name ~modules mld_files
-      ~f:(compile_module sctx ~odoc ~dir ~includes ~dep_graph ~modules
-            ~lib_unique_name)
   in
+  let mld_and_odoc_files =
+    List.map mld_files ~f:(fun m ->
+      compile sctx ~odoc ~dir ~includes ~dep_graph ~modules
+        ~lib_unique_name (Mld m))
+  in
+  let modules_and_odoc_files =
+    List.map (String_map.values modules) ~f:(fun m ->
+      compile sctx ~odoc ~dir ~includes ~dep_graph ~modules
+        ~lib_unique_name (Module m))
+  in
+  let inputs_and_odoc_files = modules_and_odoc_files @ mld_and_odoc_files in
   SC.Libs.setup_file_deps_alias sctx ~ext:odoc_ext (dir, lib)
-    (List.map modules_and_odoc_files ~f:snd);
+    (List.map inputs_and_odoc_files ~f:snd);
   let doc_dir = doc_dir ~context in
-    (*
+  (*
-     let modules_and_odoc_files =
+    let modules_and_odoc_files =
-     if lib.wrapped then
+    if lib.wrapped then
-     let main_module_name = String.capitalize_ascii lib.name in
+    let main_module_name = String.capitalize_ascii lib.name in
-     List.filter modules_and_odoc_files
+    List.filter modules_and_odoc_files
-     ~f:(fun (m, _) -> m.Module.name = main_module_name)
+    ~f:(fun (m, _) -> m.Module.name = main_module_name)
-     else
+    else
-     modules_and_odoc_files
+    modules_and_odoc_files
-       in*)
+    in*)
   let html_files =
-    List.map modules_and_odoc_files ~f:(fun (m, odoc_file) ->
+    List.map inputs_and_odoc_files ~f:(fun (m, odoc_file) ->
       to_html sctx m odoc_file ~doc_dir ~odoc ~dir ~includes ~lib
         ~lib_unique_name)
   in
-  let lib_index_html =
-    lib_index sctx ~dir ~lib ~lib_unique_name ~lib_name ~doc_dir
-      ~modules ~includes ~odoc
-  in
   SC.add_alias_deps sctx (Build_system.Alias.doc ~dir)
     (css_file ~doc_dir
      :: toplevel_index ~doc_dir
-     :: lib_index_html
      :: html_files)
 
 let setup_css_rule sctx =

src/odoc.mli

@@ -8,6 +8,7 @@ val setup_library_rules
   -> Library.t
   -> dir:Path.t
   -> modules:Module.t String_map.t
+  -> mld_files:string list
   -> requires:(unit, Lib.t list) Build.t
   -> dep_graph:Ocamldep.dep_graph
   -> unit