Remove the old asset pipeline

This removes a deprecated-before-use pipeline, and allows to finally remove the
extra_documents in renderers

Author: panglesd

src/document/renderer.ml

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

src/model/lang.ml

@@ -525,11 +525,7 @@ end =
   Implementation
 
 module rec Page : sig
-  type child =
-    | Page_child of string
-    | Module_child of string
-    | Source_tree_child of string
-    | Asset_child of string
+  type child = Page_child of string | Module_child of string
 
   type t = {
     name : Identifier.Page.t;

src/odoc/bin/main.ml

@@ -1174,27 +1174,19 @@ module Odoc_html_args = struct
     in
     Arg.(value & flag & info ~doc [ "as-json" ])
 
-  let assets =
-    let doc =
-      "Assets files. These must match the assets listed as children during the \
-       compile phase."
-    in
-    Arg.(
-      value & opt_all convert_fpath [] & info [ "asset" ] ~doc ~docv:"file.ext")
-
   let extra_args =
     let config semantic_uris closed_details indent theme_uri support_uri
-        search_uris flat as_json assets =
+        search_uris flat as_json =
       let open_details = not closed_details in
       let html_config =
         Odoc_html.Config.v ~theme_uri ~support_uri ~search_uris ~semantic_uris
           ~indent ~flat ~open_details ~as_json ()
       in
-      { Html_page.html_config; assets }
+      { Html_page.html_config }
     in
     Term.(
       const config $ semantic_uris $ closed_details $ indent $ theme_uri
-      $ support_uri $ search_uri $ flat $ as_json $ assets)
+      $ support_uri $ search_uri $ flat $ as_json)
 end
 
 module Odoc_html = Make_renderer (Odoc_html_args)

src/odoc/compile.ml

@@ -71,8 +71,6 @@ let parse_parent_child_reference s =
   in
   match String.cut ~sep:"-" s with
   | Some ("page", n) -> Ok (Lang.Page.Page_child (unquote n))
-  | Some ("srctree", n) -> Ok (Source_tree_child (unquote n))
-  | 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")
@@ -85,8 +83,7 @@ let resolve_parent_page resolver f =
         match Resolver.lookup_page resolver p with
         | Some r -> Ok r
         | None -> Error (`Msg "Couldn't find specified parent page"))
-    | Source_tree_child _ | Module_child _ | Asset_child _ ->
-        Error (`Msg "Expecting page as parent")
+    | Module_child _ -> Error (`Msg "Expecting page as parent")
   in
   let extract_parent = function
     | { Paths.Identifier.iv = `Page _; _ } as container -> Ok container
@@ -171,7 +168,7 @@ let root_of_compilation_unit ~parent_id ~parents_children ~hidden ~output
           Filename.chop_extension Fs.File.(to_string @@ basename output)
         in
         String.Ascii.(uncapitalize n = uncapitalize filename)
-    | Asset_child _ | Source_tree_child _ | Page_child _ -> false
+    | Page_child _ -> false
   in
   match parents_children with
   | Some parents_children ->
@@ -215,7 +212,7 @@ let mld ~parent_id ~parents_children ~output ~children ~warnings_options input =
   let page_name = PageName.make_std root_name in
   let check_child = function
     | Lang.Page.Page_child n -> root_name = n
-    | Asset_child _ | Source_tree_child _ | Module_child _ -> false
+    | Module_child _ -> false
   in
   (if children = [] then
      (* No children, this is a leaf page. *)

src/odoc/html_page.ml

@@ -14,65 +14,9 @@
  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  *)
 
-open Odoc_model
+type args = { html_config : Odoc_html.Config.t }
 
-type args = { html_config : Odoc_html.Config.t; assets : Fpath.t list }
-
-let render { html_config; assets = _ } sidebar page =
+let render { html_config } sidebar page =
   Odoc_html.Generator.render ~config:html_config ~sidebar page
 
-let asset_documents parent_id children asset_paths =
-  let asset_names =
-    Odoc_utils.List.filter_map
-      (function Lang.Page.Asset_child name -> Some name | _ -> None)
-      children
-  in
-  let rec extract paths name =
-    match paths with
-    | [] -> (paths, (name, None))
-    | x :: xs when Fpath.basename x = name -> (xs, (name, Some x))
-    | x :: xs ->
-        let rest, elt = extract xs name in
-        (x :: rest, elt)
-  in
-  let unmatched, paired_or_missing =
-    let rec foldmap paths paired = function
-      | [] -> (paths, paired)
-      | name :: names ->
-          let paths, pair = extract paths name in
-          foldmap paths (pair :: paired) names
-    in
-    foldmap asset_paths [] asset_names
-  in
-  List.iter
-    (fun asset ->
-      Error.raise_warning
-        (Error.filename_only "this asset was not declared as a child of %s"
-           (Paths.Identifier.name parent_id)
-           (Fs.File.to_string asset)))
-    unmatched;
-  Odoc_utils.List.filter_map
-    (fun (name, path) ->
-      match path with
-      | None ->
-          Error.raise_warning (Error.filename_only "asset is missing." name);
-          None
-      | Some path ->
-          let asset_id =
-            Paths.Identifier.Mk.asset_file
-              (parent_id, Names.AssetName.make_std name)
-          in
-          let url = Odoc_document.Url.Path.from_identifier asset_id in
-          Some (Odoc_document.Types.Document.Asset { url; src = path }))
-    paired_or_missing
-
-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
-         [render] function to allow to remove the [extra_documents]
-         machinery? *)
-      []
-  | Page page -> asset_documents page.Lang.Page.name page.children args.assets
-
-let renderer = { Odoc_document.Renderer.name = "html"; render; extra_documents }
+let renderer = { Odoc_document.Renderer.name = "html"; render }

src/odoc/html_page.mli

@@ -16,6 +16,6 @@
 
 open Odoc_document
 
-type args = { html_config : Odoc_html.Config.t; assets : Fpath.t list }
+type args = { html_config : Odoc_html.Config.t }
 
 val renderer : args Renderer.t

src/odoc/latex.ml

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

src/odoc/man_page.ml

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

src/odoc/rendering.ml

@@ -2,26 +2,13 @@ open Odoc_document
 open Or_error
 open Odoc_model
 
-let documents_of_unit ~warnings_options ~syntax ~renderer ~extra unit =
-  Error.catch_warnings (fun () ->
-      renderer.Renderer.extra_documents extra (CU unit))
-  |> Error.handle_warnings ~warnings_options
-  >>= fun extra_docs ->
-  Ok (Renderer.document_of_compilation_unit ~syntax unit :: extra_docs)
-
-let documents_of_page ~warnings_options ~syntax ~renderer ~extra page =
-  Error.catch_warnings (fun () ->
-      renderer.Renderer.extra_documents extra (Page page))
-  |> Error.handle_warnings ~warnings_options
-  >>= fun extra_docs -> Ok (Renderer.document_of_page ~syntax page :: extra_docs)
-
-let documents_of_odocl ~warnings_options ~renderer ~extra ~syntax input =
+let document_of_odocl ~syntax input =
   Odoc_file.load input >>= fun unit ->
   match unit.content with
   | Odoc_file.Page_content odoctree ->
-      documents_of_page ~warnings_options ~syntax ~renderer ~extra odoctree
+      Ok (Renderer.document_of_page ~syntax odoctree)
   | Unit_content odoctree ->
-      documents_of_unit ~warnings_options ~syntax ~renderer ~extra odoctree
+      Ok (Renderer.document_of_compilation_unit ~syntax odoctree)
   | Impl_content _ ->
       Error
         (`Msg
@@ -33,12 +20,11 @@ let documents_of_odocl ~warnings_options ~renderer ~extra ~syntax input =
           "Wrong kind of unit: Expected a page or module unit, got an asset \
            unit. Use the dedicated command for assets.")
 
-let documents_of_input ~renderer ~extra ~resolver ~warnings_options ~syntax
-    input =
+let document_of_input ~resolver ~warnings_options ~syntax input =
   let output = Fs.File.(set_ext ".odocl" input) in
   Odoc_link.from_odoc ~resolver ~warnings_options input output >>= function
-  | `Page page -> Ok [ Renderer.document_of_page ~syntax page ]
-  | `Module m -> documents_of_unit ~warnings_options ~syntax ~renderer ~extra m
+  | `Page page -> Ok (Renderer.document_of_page ~syntax page)
+  | `Module m -> Ok (Renderer.document_of_compilation_unit ~syntax m)
   | `Impl _ ->
       Error
         (`Msg
@@ -81,26 +67,20 @@ let render_document renderer ~sidebar ~output:root_dir ~extra_suffix ~extra doc
 let render_odoc ~resolver ~warnings_options ~syntax ~renderer ~output extra file
     =
   let extra_suffix = None in
-  documents_of_input ~renderer ~extra ~resolver ~warnings_options ~syntax file
-  >>= fun docs ->
-  List.iter
-    (render_document renderer ~sidebar:None ~output ~extra_suffix ~extra)
-    docs;
+  document_of_input ~resolver ~warnings_options ~syntax file >>= fun doc ->
+  render_document renderer ~sidebar:None ~output ~extra_suffix ~extra doc;
   Ok ()
 
-let generate_odoc ~syntax ~warnings_options ~renderer ~output ~extra_suffix
+let generate_odoc ~syntax ~warnings_options:_ ~renderer ~output ~extra_suffix
     ~sidebar extra file =
   (match sidebar with
   | None -> Ok None
   | Some x ->
       Odoc_file.load_index x >>= fun (sidebar, _) ->
       Ok (Some (Odoc_document.Sidebar.of_lang sidebar)))
   >>= fun sidebar ->
-  documents_of_odocl ~warnings_options ~renderer ~extra ~syntax file
-  >>= fun docs ->
-  List.iter
-    (render_document renderer ~output ~sidebar ~extra_suffix ~extra)
-    docs;
+  document_of_odocl ~syntax file >>= fun doc ->
+  render_document renderer ~output ~sidebar ~extra_suffix ~extra doc;
   Ok ()
 
 let documents_of_implementation ~warnings_options:_ ~syntax impl source_file =
@@ -148,20 +128,16 @@ let generate_asset_odoc ~warnings_options:_ ~renderer ~output ~asset_file
 
 let targets_odoc ~resolver ~warnings_options ~syntax ~renderer ~output:root_dir
     ~extra odoctree =
-  let docs =
+  let doc =
     if Fpath.get_ext odoctree = ".odoc" then
-      documents_of_input ~renderer ~extra ~resolver ~warnings_options ~syntax
-        odoctree
-    else documents_of_odocl ~warnings_options ~renderer ~extra ~syntax odoctree
+      document_of_input ~resolver ~warnings_options ~syntax odoctree
+    else document_of_odocl ~syntax odoctree
   in
-  docs >>= fun docs ->
-  List.iter
-    (fun doc ->
-      let pages = renderer.Renderer.render extra None doc in
-      Renderer.traverse pages ~f:(fun filename _content ->
-          let filename = Fpath.normalize @@ Fs.File.append root_dir filename in
-          Format.printf "%a\n" Fpath.pp filename))
-    docs;
+  doc >>= fun doc ->
+  let pages = renderer.Renderer.render extra None doc in
+  Renderer.traverse pages ~f:(fun filename _content ->
+      let filename = Fpath.normalize @@ Fs.File.append root_dir filename in
+      Format.printf "%a\n" Fpath.pp filename);
   Ok ()
 
 let targets_source_odoc ~syntax ~warnings_options ~renderer ~output:root_dir

src/xref2/link.ml

@@ -1109,7 +1109,6 @@ let page env page =
     List.iter
       (fun child ->
         match child with
-        | Page.Asset_child _ | Page.Source_tree_child _ -> ()
         | Page.Page_child page -> (
             match Env.lookup_page_by_name page env with
             | Ok _ -> ()