Remove generation of implementation using html-generate

Author: panglesd

src/odoc/bin/main.ml

@@ -38,14 +38,6 @@ let convert_fpath =
   and print = Fpath.pp in
   Arg.conv (parse, print)
 
-let convert_src_fpath =
-  let parse inp =
-    match Arg.(conv_parser file) inp with
-    | Ok s -> Result.Ok (Fs.File.of_string s)
-    | Error _ as e -> e
-  and print = Fpath.pp in
-  Arg.conv (parse, print)
-
 let convert_named_root =
   let parse inp =
     match Astring.String.cuts inp ~sep:":" with
@@ -831,20 +823,10 @@ end = struct
 
   module Generate = struct
     let generate extra _hidden output_dir syntax extra_suffix input_file
-        warnings_options source_file sidebar =
+        warnings_options sidebar =
       let file = Fs.File.of_string input_file in
       Rendering.generate_odoc ~renderer:R.renderer ~warnings_options ~syntax
-        ~output:output_dir ~extra_suffix ~source_file ~sidebar extra file
-
-    let source_file =
-      let doc =
-        "(EXPERIMENTAL) Source code for the compilation unit. It must have \
-         been compiled with --source-parent passed."
-      in
-      Arg.(
-        value
-        & opt (some convert_src_fpath) None
-        & info [ "source" ] ~doc ~docv:"file.ml")
+        ~output:output_dir ~extra_suffix ~sidebar extra file
 
     let sidebar =
       let doc = "A .odoc-index file, used eg to generate the sidebar." in
@@ -865,8 +847,7 @@ end = struct
       Term.(
         const handle_error
         $ (const generate $ R.extra_args $ hidden $ dst ~create:true () $ syntax
-         $ extra_suffix $ input_odocl $ warnings_options $ source_file $ sidebar
-          ))
+         $ extra_suffix $ input_odocl $ warnings_options $ sidebar))
 
     let info ~docs =
       let doc =
@@ -878,7 +859,7 @@ end = struct
   let generate ~docs = Generate.(cmd, info ~docs)
 
   module Targets = struct
-    let list_targets output_dir directories source_file extra odoc_file =
+    let list_targets output_dir directories extra odoc_file =
       let odoc_file = Fs.File.of_string odoc_file in
       let resolver =
         Resolver.create ~important_digests:false ~directories ~open_modules:[]
@@ -888,7 +869,7 @@ end = struct
         { Odoc_model.Error.warn_error = false; print_warnings = false }
       in
       Rendering.targets_odoc ~resolver ~warnings_options ~syntax:OCaml
-        ~renderer:R.renderer ~output:output_dir ~extra ~source_file odoc_file
+        ~renderer:R.renderer ~output:output_dir ~extra odoc_file
 
     let back_compat =
       let doc =
@@ -900,13 +881,11 @@ end = struct
         & opt_all (convert_directory ()) []
         & info ~docs ~docv:"DIR" ~doc [ "I" ])
 
-    let source_file = Generate.source_file
-
     let cmd =
       Term.(
         const handle_error
-        $ (const list_targets $ dst () $ back_compat $ source_file
-         $ R.extra_args $ input_odocl))
+        $ (const list_targets $ dst () $ back_compat $ R.extra_args
+         $ input_odocl))
 
     let info ~docs =
       let doc =

src/odoc/rendering.ml

@@ -2,78 +2,63 @@ open Odoc_document
 open Or_error
 open Odoc_model
 
-let check_empty_source_arg source filename =
-  if source <> None then
-    Error.raise_warning
-    @@ Error.filename_only
-         "--source and --source-root only have an effect when generating from \
-          an implementation"
-         filename
-
-let documents_of_unit ~warnings_options ~syntax ~source ~renderer ~extra
-    ~filename unit =
+let documents_of_unit ~warnings_options ~syntax ~renderer ~extra unit =
   Error.catch_warnings (fun () ->
-      check_empty_source_arg source filename;
       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 ~source ~renderer ~extra
-    ~filename page =
+let documents_of_page ~warnings_options ~syntax ~renderer ~extra page =
   Error.catch_warnings (fun () ->
-      check_empty_source_arg source filename;
       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_implementation ~warnings_options:_ ~syntax impl source =
-  match (source, impl.Lang.Implementation.id) with
-  | Some source_file, Some _ -> (
-      match Fs.File.read source_file with
-      | Error (`Msg msg) ->
-          Error (`Msg (Format.sprintf "Couldn't load source file: %s" msg))
-      | Ok source_code ->
-          let syntax_info =
-            Syntax_highlighter.syntax_highlighting_locs source_code
-          in
-          let rendered =
-            Odoc_document.Renderer.documents_of_implementation ~syntax impl
-              syntax_info source_code
-          in
-          Ok rendered)
-  | _, None ->
-      Error (`Msg "The implementation unit was not compiled with --source-id.")
-  | None, _ ->
-      Error
-        (`Msg
-          "--source or --source-root should be passed when generating \
-           documents for an implementation.")
+(* let documents_of_implementation ~warnings_options:_ ~syntax impl source = *)
+(*   match (source, impl.Lang.Implementation.id) with *)
+(*   | Some source_file, Some _ -> ( *)
+(*       match Fs.File.read source_file with *)
+(*       | Error (`Msg msg) -> *)
+(*           Error (`Msg (Format.sprintf "Couldn't load source file: %s" msg)) *)
+(*       | Ok source_code -> *)
+(*           let syntax_info = *)
+(*             Syntax_highlighter.syntax_highlighting_locs source_code *)
+(*           in *)
+(*           let rendered = *)
+(*             Odoc_document.Renderer.documents_of_implementation ~syntax impl *)
+(*               syntax_info source_code *)
+(*           in *)
+(*           Ok rendered) *)
+(*   | _, None -> *)
+(*       Error (`Msg "The implementation unit was not compiled with --source-id.") *)
+(*   | None, _ -> *)
+(*       Error *)
+(*         (`Msg *)
+(* "--source or --source-root should be passed when generating \ *)
+   (*            documents for an implementation.") *)
 
-let documents_of_odocl ~warnings_options ~renderer ~extra ~source ~syntax input
-    =
+let documents_of_odocl ~warnings_options ~renderer ~extra ~syntax input =
   Odoc_file.load input >>= fun unit ->
-  let filename = Fpath.to_string input in
   match unit.content with
   | Odoc_file.Page_content odoctree ->
-      documents_of_page ~warnings_options ~syntax ~source ~renderer ~extra
-        ~filename odoctree
-  | Impl_content impl ->
-      documents_of_implementation ~warnings_options ~syntax impl source
+      documents_of_page ~warnings_options ~syntax ~renderer ~extra odoctree
+  | Impl_content _impl ->
+      (* documents_of_implementation ~warnings_options ~syntax impl source *)
+      failwith "TODO ERROR"
   | Unit_content odoctree ->
-      documents_of_unit ~warnings_options ~source ~syntax ~renderer ~extra
-        ~filename odoctree
+      documents_of_unit ~warnings_options ~syntax ~renderer ~extra odoctree
   | Asset_content _ -> Ok [] (* TODO *)
 
 let documents_of_input ~renderer ~extra ~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 ]
-  | `Impl impl -> Ok (Renderer.documents_of_implementation ~syntax impl [] "")
-  | `Module m ->
-      documents_of_unit ~warnings_options ~source:None ~filename:"" ~syntax
-        ~renderer ~extra m
+  | `Impl _impl ->
+      (* Ok (Renderer.documents_of_implementation ~syntax impl [] "") *)
+      failwith "TODO ERROR"
+  | `Module m -> documents_of_unit ~warnings_options ~syntax ~renderer ~extra m
   | `Asset _ -> Ok [] (* TODO *)
 
 let render_document renderer ~sidebar ~output:root_dir ~extra_suffix ~extra doc
@@ -115,30 +100,27 @@ let render_odoc ~resolver ~warnings_options ~syntax ~renderer ~output extra file
   Ok ()
 
 let generate_odoc ~syntax ~warnings_options ~renderer ~output ~extra_suffix
-    ~source_file ~sidebar extra file =
+    ~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 ~source:source_file ~extra
-    ~syntax file
+  documents_of_odocl ~warnings_options ~renderer ~extra ~syntax file
   >>= fun docs ->
   List.iter
     (render_document renderer ~output ~sidebar ~extra_suffix ~extra)
     docs;
   Ok ()
 
 let targets_odoc ~resolver ~warnings_options ~syntax ~renderer ~output:root_dir
-    ~extra ~source_file odoctree =
+    ~extra odoctree =
   let docs =
     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
-        ~source:source_file odoctree
+    else documents_of_odocl ~warnings_options ~renderer ~extra ~syntax odoctree
   in
   docs >>= fun docs ->
   List.iter

src/odoc/rendering.mli

@@ -17,7 +17,6 @@ val generate_odoc :
   renderer:'a Renderer.t ->
   output:Fs.directory ->
   extra_suffix:string option ->
-  source_file:Fpath.t option ->
   sidebar:Fpath.t option ->
   'a ->
   Fpath.t ->
@@ -30,6 +29,5 @@ val targets_odoc :
   renderer:'a Renderer.t ->
   output:Fs.directory ->
   extra:'a ->
-  source_file:Fpath.t option ->
   Fpath.t ->
   (unit, [> msg ]) result