Docs breadcrumbs: use the one computed by odoc without processing

Co-authored-by: Jon Ludlam <[email protected]>

Author: panglesd

src/ocamlorg_frontend/components/package_breadcrumbs.eml

@@ -11,11 +11,6 @@ type path_item =
   | ClassType of breadcrumb
   | Page of breadcrumb
 
-type docs_path =
-  | Index
-  | Page of string
-  | Library of string * path_item list
-
 let kind_tag (m : path_item) = match m with
   | Module _ ->
     <span tabindex="0" aria-label="module" class="breadcrumbs-tag module-tag">Module</span>
@@ -32,7 +27,7 @@ let kind_tag (m : path_item) = match m with
 
 type path =
   | Overview of string option
-  | Documentation of (docs_path)
+  | Documentation of path_item list
 
 let render_package_and_version
 ~path
@@ -73,7 +68,6 @@ let path_item_to_breadcrumb = function
 let is_page : path_item -> bool = function Page _ -> true | _ -> false
 
 let render_path_breadcrumbs
-~library_name
 ~(path: path_item list) =
   let pages, modules = List.partition is_page path in
   let render_breadcrumb max i b =
@@ -87,11 +81,6 @@ let render_path_breadcrumbs
     | Some href ->
       <a href="<%s! href %>" aria-current="page" class="text-content dark:text-dark-title mr-2"><%s b.name %></a>
   in
-  let library_name =
-    <li>
-      <span tabindex="0" class="text-content dark:text-dark-content"><%s library_name %> lib</span>
-    </li>
-  in
   let li content =
     <li class="flex flex-wrap items-center">
     <%s! content %>
@@ -103,31 +92,17 @@ let render_path_breadcrumbs
       <%s! String.concat "<span>.</span>" (List.mapi (render_breadcrumb (List.length modules - 1)) (List.map path_item_to_breadcrumb modules)) %>
   in
   let last = kind_tag (List.hd (List.rev path)) in
-  library_name ^
   if List.length modules > 0 then
     page_items ^ li (ms ^ last)
   else
     page_items
 
 let render_docs_path_breadcrumbs
-~(path: docs_path)
-(package: Package.package)
+~(path: path_item list)
   =
-  let version = Package.url_version package in
   <nav aria-label="breadcrumb" class="flex mb-6 border-b pb-6">
     <ul class="flex flex-wrap gap-x-2 text-base leading-7 package-breadcrumbs">
-      <li>
-        <a class="underline font-semibold text-content dark:text-dark-title hover:text-primary dark:hover:text-dark-primary" href="<%s! Url.Package.documentation package.name ?version %>">Documentation</a>
-      </li>
-      <% (match path with
-         | Index -> %>
-      <% | Library (library_name, library_path) -> %>
-        <%s! if library_path != [] then render_path_breadcrumbs ~library_name ~path:library_path else "ERROR: library path is []" %>
-      <% | Page page_name  -> %>
-        <li>
-          <span><%s page_name %></span>
-        </li>
-      <% ); %>
+      <%s! if path != [] then render_path_breadcrumbs ~path else "ERROR: library path is []" %>
     </ul>
   </nav>
 
@@ -145,8 +120,7 @@ let render_overview_breadcrumbs
 
 let render
 ~(path: path)
-(package: Package.package)
 =
   match path with
     | Overview page -> render_overview_breadcrumbs page
-    | Documentation (docs_path) -> render_docs_path_breadcrumbs ~path:docs_path package
+    | Documentation (docs_path) -> render_docs_path_breadcrumbs ~path:docs_path

src/ocamlorg_frontend/pages/package_documentation.eml

@@ -34,17 +34,15 @@ let render
 let str_path =
   match path with
     | Overview _ -> []
-    | Documentation (docs_path) -> (match docs_path with
-        | Package_breadcrumbs.Index -> []
-        | Library (s, p) -> s :: List.map (function
-            | Package_breadcrumbs.Module { name ; _ } -> name
-            | ModuleType { name ; _ } -> name
-            | Parameter  ({ name ; _ }, _) -> name
-            | Class { name ; _ } -> name
-            | ClassType { name ; _ } -> name
-            | Page { name; _ } -> name
-          ) p
-        | Page s -> [""; s])
+    | Documentation (docs_path) ->
+        List.map (function
+          | Package_breadcrumbs.Module { name ; _ }
+          | ModuleType { name ; _ }
+          | Parameter  ({ name ; _ }, _)
+          | Class { name ; _ }
+          | ClassType { name ; _ }
+          | Page { name; _ } -> name
+        ) docs_path |> List.tl
 in
 Package_layout.render
 ~title:(Printf.sprintf "%s %s · OCaml Package" package.name (Package.render_version package))
@@ -58,7 +56,7 @@ Package_layout.render
 ~left_sidebar_html:(sidebar ~str_path ~local_toc ~global_toc package)
 ~right_sidebar_html:(right_sidebar ~local_toc) @@
 <div id="htmx-content">
-  <%s! Package_breadcrumbs.render ~path package %>
+  <%s! Package_breadcrumbs.render ~path %>
   <div class="odoc prose dark:prose-invert prose-orange">
     <%s! content %>
   </div>

src/ocamlorg_web/lib/handler.ml

@@ -1236,7 +1236,7 @@ let package_documentation t kind req =
         Dream.html ~code:404
           (Ocamlorg_frontend.package_documentation_not_found ~page:path
              ~search_index_digest:None
-             ~path:(Ocamlorg_frontend.Package_breadcrumbs.Documentation Index)
+             ~path:(Ocamlorg_frontend.Package_breadcrumbs.Documentation [])
              frontend_package)
       in
       if version_from_url = "latest" then
@@ -1287,43 +1287,25 @@ let package_documentation t kind req =
       in
       let (breadcrumb_path : Ocamlorg_frontend.Package_breadcrumbs.path) =
         let breadcrumbs = doc.breadcrumbs in
-        if breadcrumbs != [] then
-          let first_path_item = List.hd breadcrumbs in
-          let doc_breadcrumb_to_library_path_item
-              (p : Ocamlorg_package.Documentation.breadcrumb) =
-            let breadcrumb : Ocamlorg_frontend.Package_breadcrumbs.breadcrumb =
-              { name = p.name; href = p.href }
-            in
-            match p.kind with
-            | Module -> Ocamlorg_frontend.Package_breadcrumbs.Module breadcrumb
-            | ModuleType -> ModuleType breadcrumb
-            | Parameter number -> Parameter (breadcrumb, number)
-            | Class -> Class breadcrumb
-            | ClassType -> ClassType breadcrumb
-            | Page | LeafPage | File ->
-                failwith "library paths do not contain Page, LeafPage or File"
+        let doc_breadcrumb_to_library_path_item
+            (p : Ocamlorg_package.Documentation.breadcrumb) =
+          let b =
+            {
+              Ocamlorg_frontend.Package_breadcrumbs.name = p.name;
+              href = p.href;
+            }
           in
+          match p.kind with
+          | Module -> Ocamlorg_frontend.Package_breadcrumbs.Module b
+          | ModuleType -> ModuleType b
+          | Parameter i -> Parameter (b, i)
+          | Class -> Class b
+          | ClassType -> ClassType b
+          | Page | LeafPage | File -> Page b
+        in
 
-          match first_path_item.kind with
-          | Page | LeafPage | File ->
-              Ocamlorg_frontend.Package_breadcrumbs.Documentation
-                (Page first_path_item.name)
-          | Module | ModuleType | Parameter _ | Class | ClassType ->
-              let library =
-                List.find_opt
-                  (fun (toc : Ocamlorg_frontend.Navmap.toc) ->
-                    List.exists
-                      (fun (t : Ocamlorg_frontend.Navmap.toc) ->
-                        t.title = first_path_item.name)
-                      toc.children)
-                  global_toc
-              in
-
-              Ocamlorg_frontend.Package_breadcrumbs.Documentation
-                (Library
-                   ( (match library with Some l -> l.title | None -> "unknown"),
-                     List.map doc_breadcrumb_to_library_path_item breadcrumbs ))
-        else Ocamlorg_frontend.Package_breadcrumbs.Documentation Index
+        Ocamlorg_frontend.Package_breadcrumbs.Documentation
+          (List.map doc_breadcrumb_to_library_path_item breadcrumbs)
       in
       Dream.html
         (Ocamlorg_frontend.package_documentation ~page:(Some path)