WIP

Author: panglesd

src/document/sidebar.ml

@@ -68,9 +68,8 @@ type t = { pages : pages list; libraries : library list }
 let of_lang (v : Odoc_model.Lang.Sidebar.t) =
   let sidebar_toc_entry id content =
     let href = id |> Url.Path.from_identifier |> Url.from_path in
-    let target = InternalLink.Resolved href in
-    let link = { InternalLink.target; content; tooltip = None } in
-    inline @@ Inline.InternalLink link
+    let target = Target.Internal (Resolved href) in
+    inline @@ Inline.Link { target; content; tooltip = None }
   in
   let pages =
     let page_hierarchy { Odoc_model.Lang.Sidebar.page_name; pages } =

src/latex/generator.ml

@@ -219,13 +219,13 @@ let source k (t : Source.t) =
   and tokens t = Odoc_utils.List.concat_map t ~f:token in
   tokens t
 
-let rec internalref ~verbatim ~in_source (t : InternalLink.t) =
+let rec internalref ~verbatim ~in_source (t : Target.internal) (c : Inline.t) =
   let target =
-    match t.target with
-    | InternalLink.Resolved uri -> Link.label uri
+    match t with
+    | Target.Resolved uri -> Link.label uri
     | Unresolved -> "xref-unresolved"
   in
-  let text = Some (inline ~verbatim ~in_source t.content) in
+  let text = Some (inline ~verbatim ~in_source c) in
   let short = in_source in
   Internal_ref { short; target; text }
 
@@ -235,10 +235,11 @@ and inline ~in_source ~verbatim (l : Inline.t) =
     | Text _s -> assert false
     | Linebreak -> [ Break Line ]
     | Styled (style, c) -> [ Style (style, inline ~verbatim ~in_source c) ]
-    | Link (ext, c) ->
+    | Link { target = External ext; content = c; _ } ->
         let content = inline ~verbatim:false ~in_source:false c in
         [ External_ref (ext, Some content) ]
-    | InternalLink c -> [ internalref ~in_source ~verbatim c ]
+    | Link { target = Internal ref_; content = c; _ } ->
+        [ internalref ~in_source ~verbatim ref_ c ]
     | Source c ->
         [ Inlined_code (source (inline ~verbatim:false ~in_source:true) c) ]
     | Math s -> [ Raw (Format.asprintf "%a" Raw.math s) ]
@@ -280,6 +281,9 @@ let rec block ~in_source (l : Block.t) =
   let one (t : Block.one) =
     match t.desc with
     | Inline i -> inline ~verbatim:false ~in_source:false i
+    | Audio (_, content) | Video (_, content) | Image (_, content) ->
+        inline ~verbatim:false ~in_source:false content
+        @ if in_source then [] else [ Break Paragraph ]
     | Paragraph i ->
         inline ~in_source:false ~verbatim:false i
         @ if in_source then [] else [ Break Paragraph ]

src/manpage/generator.ml

@@ -1,6 +1,8 @@
+module ManLink = Link
 open Odoc_document
 open Types
 open Doctree
+module Link = ManLink
 
 (*
 Manpages relies on the (g|t|n)roff document language.
@@ -247,7 +249,7 @@ let strip l =
               { h with desc = Styled (sty, List.rev @@ loop [] content) }
             in
             loop (h :: acc) t
-        | Link (_, content) | InternalLink { content; _ } ->
+        | Link { content; _ } ->
             let acc = loop acc content in
             loop acc t
         | Source code ->
@@ -303,9 +305,9 @@ and inline (l : Inline.t) =
           x ++ inline rest
       | Linebreak -> break ++ inline rest
       | Styled (sty, content) -> style sty (inline content) ++ inline rest
-      | Link (href, content) ->
+      | Link { target = External href; content; _ } ->
           env "UR" "UE" href (inline @@ strip content) ++ inline rest
-      | InternalLink { content; _ } ->
+      | Link { content; _ } ->
           font "CI" (inline @@ strip content) ++ inline rest
       | Source content -> source_code content ++ inline rest
       | Math s -> math s ++ inline rest
@@ -365,6 +367,8 @@ let rec block (l : Block.t) =
       let continue r = if r = [] then noop else vspace ++ block r in
       match b.desc with
       | Inline i -> inline i ++ continue rest
+      | Video (_, content) | Audio (_, content) | Image (_, content) ->
+          inline content ++ continue rest
       | Paragraph i -> inline i ++ continue rest
       | List (list_typ, l) ->
           let f n b =

src/model/paths.ml

@@ -1182,6 +1182,10 @@ module Reference = struct
     type t = Paths_types.Reference.page
   end
 
+  module Asset = struct
+    type t = Paths_types.Reference.asset
+  end
+
   module Hierarchy = struct
     type t = Paths_types.Reference.hierarchy
   end

src/model/paths.mli

@@ -640,6 +640,10 @@ module rec Reference : sig
     type t = Paths_types.Reference.page
   end
 
+  module Asset : sig
+    type t = Paths_types.Reference.asset
+  end
+
   module Hierarchy : sig
     type t = Paths_types.Reference.hierarchy
   end

src/model/paths_types.ml

@@ -652,7 +652,8 @@ module rec Reference : sig
     | `Type of signature * TypeName.t ]
   (** @canonical Odoc_model.Paths.Reference.LabelParent.t *)
 
-  type asset = [ `Asset_path of hierarchy ]
+  type asset =
+    [ `Resolved of Resolved_reference.asset | `Asset_path of hierarchy ]
 
   type module_ =
     [ `Resolved of Resolved_reference.module_

src/model/semantics.ml

@@ -302,10 +302,10 @@ let rec nestable_block_element :
           let asset_ref_of_ref :
               Paths.Reference.t -> (Paths.Reference.Asset.t, _) Result.result =
             function
-            | `Asset _ as a -> Result.Ok a
-            | `Root (_, `TAsset) as a -> Ok a
-            | `Root (s, `TUnknown) -> Ok (`Root (s, `TAsset))
-            | `Dot (p, s) -> Ok (`Dot (p, s))
+            | `Asset_path _ as a -> Result.Ok a
+            (* | `Root (_, `TAsset) as a -> Ok a *)
+            (* | `Root (s, `TUnknown) -> Ok (`Root (s, `TAsset)) *)
+            (* | `Dot (p, s) -> Ok (`Dot (p, s)) *)
             | _ ->
                 Error
                   (not_allowed ~suggestion:"Use a reference to an asset"

src/search/entry.ml

@@ -137,6 +137,7 @@ and entries_of_doc id d =
   | `Verbatim _ -> [ entry ~id ~doc:[ d ] ~kind:(Doc Verbatim) ]
   | `Math_block _ -> [ entry ~id ~doc:[ d ] ~kind:(Doc MathBlock) ]
   | `Table _ -> []
+  | `Media _ -> []
 
 let entries_of_item (x : Odoc_model.Fold.item) =
   match x with

src/xref2/link.ml

@@ -295,7 +295,7 @@ and comment_nestable_block_element env parent ~loc:_
       `Modules refs
   | `Media (`Reference r, m, content) as orig -> (
       match Ref_tools.resolve_asset_reference env r |> Error.raise_warnings with
-      | Ok x -> `Media (`Reference (`Resolved x), m, content)
+      | Ok (x, _) -> `Media (`Reference (`Resolved x), m, content)
       | Error e ->
           Errors.report
             ~what:(`Reference (r :> Paths.Reference.t))

src/xref2/ref_tools.ml

@@ -831,6 +831,11 @@ let resolved3 (r, _, _) = resolved1 r
 
 and resolved2 (r, _) = resolved1 r
 
+let resolve_asset_reference env (r : Reference.Asset.t) : Asset.t ref_result =
+  match r with
+  | `Resolved _r -> failwith "What's going on!?"
+  | `Asset_path p -> Path.asset_in_env env p
+
 let resolved_type_lookup = function
   | `T (r, _) -> resolved1 r
   | `C (r, _) -> resolved1 r
@@ -995,5 +1000,8 @@ let resolve_reference : _ -> Reference.t -> _ =
 let resolve_module_reference env m =
   Odoc_model.Error.catch_warnings (fun () -> resolve_module_reference env m)
 
+let resolve_asset_reference env m =
+  Odoc_model.Error.catch_warnings (fun () -> resolve_asset_reference env m)
+
 let resolve_reference env m =
   Odoc_model.Error.catch_warnings (fun () -> resolve_reference env m)