Fix package files appearing in global toc

Author: panglesd

src/ocamlorg_package/lib/documentation_status.ml

@@ -19,9 +19,16 @@ let has_file (v : t) (options : string list) : string option =
       children
   with Not_found -> None
 
-let license (v : t) = has_file v [ "LICENSE"; "LICENCE" ]
-let readme (v : t) = has_file v [ "README"; "Readme"; "readme" ]
+let license_names = [ "LICENSE"; "LICENCE" ]
+let readme_names = [ "README"; "Readme"; "readme" ]
 
-let changelog (v : t) =
-  has_file v
-    [ "CHANGELOG"; "Changelog"; "changelog"; "CHANGES"; "Changes"; "changes" ]
+let changelog_names =
+  [ "CHANGELOG"; "Changelog"; "changelog"; "CHANGES"; "Changes"; "changes" ]
+
+let is_special =
+  let names = license_names @ readme_names @ changelog_names in
+  fun x -> List.mem x names
+
+let license (v : t) = has_file v license_names
+let readme (v : t) = has_file v readme_names
+let changelog (v : t) = has_file v changelog_names

src/ocamlorg_package/lib/documentation_status.mli

@@ -16,3 +16,4 @@ type t = {
 val readme : t -> string option
 val license : t -> string option
 val changelog : t -> string option
+val is_special : string -> bool

src/ocamlorg_web/lib/handler.ml

@@ -1282,7 +1282,8 @@ let package_documentation t kind req =
       else response_404_page
   | Some doc ->
       let map_url = Option.map (fun url -> "/" ^ url) in
-      let rec navmap_of_sidebar (sidebar : Ocamlorg_package.Sidebar.tree) =
+      let rec navmap_of_sidebar ?(first_layer = false)
+          (sidebar : Ocamlorg_package.Sidebar.tree) =
         Ocamlorg_frontend.Navmap.
           {
             title = sidebar.node.content;
@@ -1303,7 +1304,24 @@ let package_documentation t kind req =
               | None -> Page
               | _ -> File);
             href = map_url sidebar.node.url;
-            children = List.map navmap_of_sidebar sidebar.children;
+            children =
+              (let children =
+                 List.map
+                   (navmap_of_sidebar ~first_layer:false)
+                   sidebar.children
+               in
+               (* The docs CI generates readme files in the wring place, and
+                  they end up in the toc, so we filter them out here *)
+               if first_layer then
+                 List.filter
+                   (function
+                     | Ocamlorg_frontend.Navmap.{ title; _ }
+                       when Ocamlorg_package.Documentation_status.is_special
+                              title ->
+                         false
+                     | _ -> true)
+                   children
+               else children);
           }
       in
       let* sidebar = Ocamlorg_package.sidebar ~kind package in
@@ -1312,7 +1330,7 @@ let package_documentation t kind req =
       in
       let local_toc = Package_helper.frontend_toc doc.toc in
       let (global_toc : Ocamlorg_frontend.Navmap.toc list) =
-        List.map navmap_of_sidebar sidebar
+        List.map (navmap_of_sidebar ~first_layer:true) sidebar
       in
       let (breadcrumb_path : Ocamlorg_frontend.Package_breadcrumbs.path) =
         let breadcrumbs = doc.breadcrumbs in