Review comments

- Rename `--source-parent-file` into `parent`
- Check that source argument is empty in case of rendering source tree
- Removed now useless `syntax` argument from `extra_documents`
- Check `"src-"`prefix when loading units for counting occurrences to avoid
  loading for nothing
- fixed some typos and made some small refactoring

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

Author: panglesd

src/document/renderer.ml

@@ -24,7 +24,7 @@ type input =
 type 'a t = {
   name : string;
   render : 'a -> Types.Document.t -> page list;
-  extra_documents : 'a -> input -> syntax:syntax -> Types.Document.t list;
+  extra_documents : 'a -> input -> Types.Document.t list;
 }
 
 let document_of_page ~syntax v =

src/odoc/compile.ml

@@ -40,7 +40,7 @@ let is_module_name n = String.length n > 0 && Char.Ascii.is_upper n.[0]
     - [module-Foo] child is a module.
     - [module-foo], [Foo] child is a module, for backward compatibility.
     - [page-foo] child is a container or leaf page.
-    - [src-foo] child is a source tree
+    - [srctree-foo] child is a source tree
 
   Parses [...-"foo"] as [...-foo] for backward compatibility. *)
 let parse_parent_child_reference s =
@@ -56,6 +56,7 @@ let parse_parent_child_reference s =
   | Some ("asset", n) -> Ok (Asset_child (unquote n))
   | Some ("module", n) ->
       Ok (Module_child (unquote (String.Ascii.capitalize n)))
+  | Some ("src", _) -> Error (`Msg "Implementation unexpected")
   | Some (k, _) -> Error (`Msg ("Unrecognized kind: " ^ k))
   | None -> if is_module_name s then Ok (Module_child s) else Ok (Page_child s)
 

src/odoc/compile.mli

@@ -27,6 +27,11 @@ val name_of_output : prefix:string -> Fs.File.t -> string
 (** Compute the name of the page from the output file. Prefix is the prefix to
     remove from the filename. *)
 
+val resolve_imports :
+  Resolver.t ->
+  Lang.Compilation_unit.Import.t list ->
+  Lang.Compilation_unit.Import.t list
+
 val resolve_parent_page :
   Resolver.t ->
   string ->

src/odoc/depends.ml

@@ -77,25 +77,23 @@ end = struct
     Odoc_model.Root.Hash_table.fold (fun s () acc -> s :: acc) t []
 end
 
+let deps_of_imports ~deps imports =
+  List.iter imports ~f:(fun import ->
+      match import with
+      | Odoc_model.Lang.Compilation_unit.Import.Unresolved _ -> ()
+      | Odoc_model.Lang.Compilation_unit.Import.Resolved (root, _) ->
+          Hash_set.add deps root);
+  Ok ()
+
 let deps_of_odoc_file ~deps input =
   Odoc_file.load input >>= fun unit ->
   match unit.content with
   | Page_content _ | Source_tree_content _ ->
       Ok () (* XXX something should certainly be done here *)
   | Impl_content impl ->
-      List.iter impl.Odoc_model.Lang.Implementation.imports ~f:(fun import ->
-          match import with
-          | Odoc_model.Lang.Compilation_unit.Import.Unresolved _ -> ()
-          | Odoc_model.Lang.Compilation_unit.Import.Resolved (root, _) ->
-              Hash_set.add deps root);
-      Ok ()
+      deps_of_imports ~deps impl.Odoc_model.Lang.Implementation.imports
   | Unit_content unit ->
-      List.iter unit.Odoc_model.Lang.Compilation_unit.imports ~f:(fun import ->
-          match import with
-          | Odoc_model.Lang.Compilation_unit.Import.Unresolved _ -> ()
-          | Odoc_model.Lang.Compilation_unit.Import.Resolved (root, _) ->
-              Hash_set.add deps root);
-      Ok ()
+      deps_of_imports ~deps unit.Odoc_model.Lang.Compilation_unit.imports
 
 let for_rendering_step pkg_dir =
   let deps = Hash_set.create () in

src/odoc/html_page.ml

@@ -69,7 +69,7 @@ let asset_documents parent_id children asset_paths =
           Some (Odoc_document.Types.Document.Asset { url; src = path }))
     paired_or_missing
 
-let extra_documents args input ~syntax:_ =
+let extra_documents args input =
   match input with
   | Odoc_document.Renderer.CU _unit ->
       (* Remove assets from [Document.t] and move their rendering in the main

src/odoc/latex.ml

@@ -5,6 +5,6 @@ type args = { with_children : bool }
 let render args page =
   Odoc_latex.Generator.render ~with_children:args.with_children page
 
-let extra_documents _args _unit ~syntax:_ = []
+let extra_documents _args _unit = []
 
 let renderer = { Renderer.name = "latex"; render; extra_documents }

src/odoc/man_page.ml

@@ -2,6 +2,6 @@ open Odoc_document
 
 let render _ page = Odoc_manpage.Generator.render page
 
-let extra_documents _args _unit ~syntax:_ = []
+let extra_documents _args _unit = []
 
 let renderer = { Renderer.name = "man"; render; extra_documents }

src/odoc/occurrences.ml

@@ -1,12 +1,14 @@
 open Or_error
 
 let handle_file file ~f =
-  Odoc_file.load file |> function
-  | Error _ as e -> e
-  | Ok unit' -> (
-      match unit' with
-      | { Odoc_file.content = Impl_content impl; _ } -> Ok (Some (f impl))
-      | _ -> Ok None)
+  if String.starts_with ~prefix:"src-" (Fpath.filename file) then
+    Odoc_file.load file |> function
+    | Error _ as e -> e
+    | Ok unit' -> (
+        match unit' with
+        | { Odoc_file.content = Impl_content impl; _ } -> Ok (Some (f impl))
+        | _ -> Ok None)
+  else Ok None
 
 let fold_dirs ~dirs ~f ~init =
   dirs

src/odoc/rendering.ml

@@ -25,7 +25,7 @@ let documents_of_unit ~warnings_options ~syntax ~source ~renderer ~extra
     ~filename unit =
   Odoc_model.Error.catch_warnings (fun () ->
       check_empty_source_arg source filename;
-      renderer.Renderer.extra_documents ~syntax extra (CU unit))
+      renderer.Renderer.extra_documents extra (CU unit))
   |> Odoc_model.Error.handle_warnings ~warnings_options
   >>= fun extra_docs ->
   Ok
@@ -36,7 +36,7 @@ let documents_of_page ~warnings_options ~syntax ~source ~renderer ~extra
     ~filename page =
   Odoc_model.Error.catch_warnings (fun () ->
       check_empty_source_arg source filename;
-      renderer.Renderer.extra_documents ~syntax extra (Page page))
+      renderer.Renderer.extra_documents extra (Page page))
   |> Odoc_model.Error.handle_warnings ~warnings_options
   >>= fun extra_docs -> Ok (Renderer.document_of_page ~syntax page :: extra_docs)
 
@@ -75,6 +75,13 @@ let documents_of_implementation ~warnings_options:_ ~syntax impl source =
           "--source or --source-root should be passed when generating \
            documents for an implementation.")
 
+let documents_of_source_tree ~warnings_options ~syntax ~source ~filename srctree
+    =
+  Odoc_model.Error.catch_warnings (fun () ->
+      check_empty_source_arg source filename)
+  |> Odoc_model.Error.handle_warnings ~warnings_options
+  >>= fun () -> Ok (Renderer.documents_of_source_tree ~syntax srctree)
+
 let documents_of_odocl ~warnings_options ~renderer ~extra ~source ~syntax input
     =
   Odoc_file.load input >>= fun unit ->
@@ -84,7 +91,8 @@ let documents_of_odocl ~warnings_options ~renderer ~extra ~source ~syntax input
       documents_of_page ~warnings_options ~syntax ~source ~renderer ~extra
         ~filename odoctree
   | Source_tree_content srctree ->
-      Ok (Renderer.documents_of_source_tree ~syntax srctree)
+      documents_of_source_tree ~warnings_options ~syntax ~source ~filename
+        srctree
   | Impl_content impl ->
       documents_of_implementation ~warnings_options ~syntax impl source
   | Unit_content odoctree ->

src/odoc/source.ml

@@ -1,34 +1,23 @@
 open Odoc_model
 open Or_error
 
-let resolve_imports resolver imports =
-  List.map
-    (function
-      | Lang.Compilation_unit.Import.Resolved _ as resolved -> resolved
-      | Unresolved (name, _) as unresolved -> (
-          match Resolver.resolve_import resolver name with
-          | Some root -> Resolved (root, Names.ModuleName.make_std name)
-          | None -> unresolved))
-    imports
-
 let resolve_and_substitute ~resolver ~make_root ~source_id input_file =
   let filename = Fs.File.to_string input_file in
   let impl =
     Odoc_loader.read_impl ~make_root ~filename ~source_id
     |> Error.raise_errors_and_warnings
   in
-  let impl = { impl with imports = resolve_imports resolver impl.imports } in
+  let impl =
+    { impl with imports = Compile.resolve_imports resolver impl.imports }
+  in
   let env = Resolver.build_compile_env_for_impl resolver impl in
   Odoc_xref2.Compile.compile_impl ~filename env impl |> Error.raise_warnings
 
 let root_of_implementation ~source_id ~module_name ~digest =
   let open Root in
-  let result =
-    let file = Odoc_file.create_impl module_name in
-    let id :> Paths.Identifier.OdocId.t = source_id in
-    Ok { id; file; digest }
-  in
-  result
+  let file = Odoc_file.create_impl module_name in
+  let id :> Paths.Identifier.OdocId.t = source_id in
+  Ok { id; file; digest }
 
 let compile ~resolver ~output ~warnings_options ~source_path ~source_parent_file
     input =