From ada99315cb91edf1fd4063faf40e3055866cb9d9 Mon Sep 17 00:00:00 2001
From: Jon Ludlam <jon@recoil.org>
Date: Thu, 4 Mar 2021 11:16:47 +0000
Subject: [PATCH 01/13] Improve --theme-uri and add --support-uri

Support-uri allows the user to specify where to find highlite.pack.js.
Both arguments are now slightly better at handling relative paths.
---
 src/html/generator.ml  |  9 +++++---
 src/html/generator.mli |  7 ++++++-
 src/html/link.ml       | 11 +++++++---
 src/html/tree.ml       | 46 +++++++++++++++++------------------------
 src/html/tree.mli      |  3 ++-
 src/odoc/bin/main.ml   | 47 +++++++++++++++++++++++++++++++++++-------
 src/odoc/html_page.ml  |  4 +++-
 src/odoc/html_page.mli |  1 +
 8 files changed, 84 insertions(+), 44 deletions(-)

diff --git a/src/html/generator.ml b/src/html/generator.ml
index e1d85b661a..8e33dd47d6 100644
--- a/src/html/generator.ml
+++ b/src/html/generator.ml
@@ -377,7 +377,8 @@ module Page = struct
     Utils.list_concat_map ~f:(include_ ?theme_uri indent)
     @@ Doctree.Subpages.compute i
 
-  and page ?theme_uri indent ({ Page.title; header; items = i; url } as p) =
+  and page ?theme_uri ?support_uri indent
+      ({ Page.title; header; items = i; url } as p) =
     let resolve = Link.Current url in
     let i = Doctree.Shift.compute ~on_sub i in
     let toc = Toc.from_items ~resolve ~path:url i in
@@ -385,12 +386,14 @@ module Page = struct
     let header = items ~resolve header in
     let content = (items ~resolve i :> any Html.elt list) in
     let page =
-      Tree.make ?theme_uri ~indent ~header ~toc ~url title content subpages
+      Tree.make ?theme_uri ?support_uri ~indent ~header ~toc ~url title content
+        subpages
     in
     page
 end
 
-let render ?theme_uri ~indent page = Page.page ?theme_uri indent page
+let render ?theme_uri ?support_uri ~indent page =
+  Page.page ?theme_uri ?support_uri indent page
 
 let doc ~xref_base_uri b =
   let resolve = Link.Base xref_base_uri in
diff --git a/src/html/generator.mli b/src/html/generator.mli
index 121388401c..586e8cee0f 100644
--- a/src/html/generator.mli
+++ b/src/html/generator.mli
@@ -1,6 +1,11 @@
 open Odoc_document
 
-val render : ?theme_uri:Tree.uri -> indent:bool -> Types.Page.t -> Renderer.page
+val render :
+  ?theme_uri:Tree.uri ->
+  ?support_uri:Tree.uri ->
+  indent:bool ->
+  Types.Page.t ->
+  Renderer.page
 
 val doc :
   xref_base_uri:string ->
diff --git a/src/html/link.ml b/src/html/link.ml
index d3463d5c6e..e1decf8240 100644
--- a/src/html/link.ml
+++ b/src/html/link.ml
@@ -17,16 +17,21 @@ module Path = struct
     | "module" | "container-page" -> name
     | _ -> Printf.sprintf "%s-%s" kind name
 
-  let is_leaf_page url = url.Url.Path.kind = "page"
+  let is_leaf_page url =
+    url.Url.Path.kind = "page" || url.Url.Path.kind = "file"
 
   let rec get_dir { Url.Path.parent; name; kind } =
     let ppath = match parent with Some p -> get_dir p | None -> [] in
     match kind with
-    | "page" -> ppath
+    | "page" | "file" -> ppath
     | _ -> ppath @ [ segment_to_string (kind, name) ]
 
   let get_file : Url.Path.t -> string =
-   fun t -> match t.kind with "page" -> t.name ^ ".html" | _ -> "index.html"
+   fun t ->
+    match t.kind with
+    | "page" -> t.name ^ ".html"
+    | "file" -> t.name
+    | _ -> "index.html"
 
   let for_linking : Url.Path.t -> string list =
    fun url -> get_dir url @ [ get_file url ]
diff --git a/src/html/tree.ml b/src/html/tree.ml
index 120be180eb..ab44da4007 100644
--- a/src/html/tree.ml
+++ b/src/html/tree.ml
@@ -16,43 +16,32 @@
 
 module Html = Tyxml.Html
 
-type uri = Absolute of string | Relative of string
+type uri = Absolute of string | Relative of Odoc_document.Url.Path.t option
 
-let page_creator ?(theme_uri = Relative "./") ~url name header toc content =
+let page_creator ?(theme_uri = Relative None) ?(support_uri = Relative None)
+    ~url name header toc content =
   let is_leaf_page = Link.Path.is_leaf_page url in
   let path = Link.Path.for_printing url in
   let rec add_dotdot ~n acc =
     if n <= 0 then acc else add_dotdot ~n:(n - 1) ("../" ^ acc)
   in
-  let resolve_relative_uri uri =
-    (* Remove the first "dot segment". *)
-    let uri =
-      if String.length uri >= 2 && String.sub uri 0 2 = "./" then
-        String.sub uri 2 (String.length uri - 2)
-      else uri
-    in
-    (* How deep is this page? *)
-    let n =
-      List.length path
-      - if (* This is just horrible. *)
-           is_leaf_page then 1 else 0
-    in
-    add_dotdot uri ~n
-  in
 
   let head : Html_types.head Html.elt =
     let title_string = Printf.sprintf "%s (%s)" name (String.concat "." path) in
 
-    let theme_uri =
-      match theme_uri with
-      | Absolute uri -> uri
-      | Relative uri -> resolve_relative_uri uri
+    let file_uri base file =
+      match base with
+      | Absolute uri -> uri ^ "/" ^ file
+      | Relative uri ->
+          let page =
+            Odoc_document.Url.Path.{ kind = "file"; parent = uri; name = file }
+          in
+          Link.href ~resolve:(Current url)
+            Odoc_document.Url.Anchor.{ page; anchor = ""; kind = "file" }
     in
 
-    let support_files_uri = resolve_relative_uri "./" in
-
-    let odoc_css_uri = theme_uri ^ "odoc.css" in
-    let highlight_js_uri = support_files_uri ^ "highlight.pack.js" in
+    let odoc_css_uri = file_uri theme_uri "odoc.css" in
+    let highlight_js_uri = file_uri support_uri "highlight.pack.js" in
 
     Html.head
       (Html.title (Html.txt title_string))
@@ -116,9 +105,12 @@ let page_creator ?(theme_uri = Relative "./") ~url name header toc content =
   in
   Html.html head (Html.body ~a:[ Html.a_class [ "odoc" ] ] body)
 
-let make ?theme_uri ~indent ~url ~header ~toc title content children =
+let make ?theme_uri ?support_uri ~indent ~url ~header ~toc title content
+    children =
   let filename = Link.Path.as_filename url in
-  let html = page_creator ?theme_uri ~url title header toc content in
+  let html =
+    page_creator ?theme_uri ?support_uri ~url title header toc content
+  in
   let content ppf = (Html.pp ~indent ()) ppf html in
   { Odoc_document.Renderer.filename; content; children }
 
diff --git a/src/html/tree.mli b/src/html/tree.mli
index b48010c0d5..15e6ac5bee 100644
--- a/src/html/tree.mli
+++ b/src/html/tree.mli
@@ -21,7 +21,7 @@ module Html = Tyxml.Html
 
 type uri =
   | Absolute of string
-  | Relative of string
+  | Relative of Odoc_document.Url.Path.t option
       (** The type for absolute and relative URIs. The relative URIs are resolved
     using the HTML output directory as a target. *)
 
@@ -29,6 +29,7 @@ type uri =
 
 val make :
   ?theme_uri:uri ->
+  ?support_uri:uri ->
   indent:bool ->
   url:Url.Path.t ->
   header:Html_types.flow5_without_header_footer Html.elt list ->
diff --git a/src/odoc/bin/main.ml b/src/odoc/bin/main.ml
index 092df4906d..383373baff 100644
--- a/src/odoc/bin/main.ml
+++ b/src/odoc/bin/main.ml
@@ -424,12 +424,26 @@ module Odoc_html = Make_renderer (struct
           || str.[0] = '/'
         in
         let last_char = str.[String.length str - 1] in
-        let str = if last_char <> '/' then str ^ "/" else str in
-        `Ok Odoc_html.Tree.(if is_absolute then Absolute str else Relative str)
+        let str =
+          if last_char <> '/' then str
+          else String.sub str ~pos:0 ~len:(String.length str - 1)
+        in
+        let conv_rel rel =
+          let l = Astring.String.cuts ~sep:"/" rel in
+          List.fold_left
+            ~f:(fun acc seg ->
+              Some
+                Odoc_document.Url.Path.
+                  { kind = "container-page"; parent = acc; name = seg })
+            l ~init:None
+        in
+        `Ok
+          Odoc_html.Tree.(
+            if is_absolute then Absolute str else Relative (conv_rel str))
     in
     let printer ppf = function
-      | Odoc_html.Tree.Absolute uri | Odoc_html.Tree.Relative uri ->
-          Format.pp_print_string ppf uri
+      | Odoc_html.Tree.Absolute uri -> Format.pp_print_string ppf uri
+      | Odoc_html.Tree.Relative _uri -> Format.pp_print_string ppf ""
     in
     (parser, printer)
 
@@ -438,15 +452,32 @@ module Odoc_html = Make_renderer (struct
       "Where to look for theme files (e.g. `URI/odoc.css'). Relative URIs are \
        resolved using `--output-dir' as a target."
     in
-    let default = Odoc_html.Tree.Relative "./" in
+    let default = Odoc_html.Tree.Relative None in
     Arg.(
       value & opt convert_uri default & info ~docv:"URI" ~doc [ "theme-uri" ])
 
+  let support_uri =
+    let doc =
+      "Where to look for support files (e.g. `URI/highlite.pack.js'). Relative \
+       URIs are resolved using `--output-dir' as a target."
+    in
+    let default = Odoc_html.Tree.Relative None in
+    Arg.(
+      value & opt convert_uri default & info ~docv:"URI" ~doc [ "support-uri" ])
+
   let extra_args =
-    let f semantic_uris closed_details indent theme_uri =
-      { Html_page.semantic_uris; closed_details; theme_uri; indent }
+    let f semantic_uris closed_details indent theme_uri support_uri =
+      {
+        Html_page.semantic_uris;
+        closed_details;
+        theme_uri;
+        support_uri;
+        indent;
+      }
     in
-    Term.(const f $ semantic_uris $ closed_details $ indent $ theme_uri)
+    Term.(
+      const f $ semantic_uris $ closed_details $ indent $ theme_uri
+      $ support_uri)
 end)
 
 module Html_fragment : sig
diff --git a/src/odoc/html_page.ml b/src/odoc/html_page.ml
index fb5c011268..d04fb306fc 100644
--- a/src/odoc/html_page.ml
+++ b/src/odoc/html_page.ml
@@ -21,12 +21,14 @@ type args = {
   closed_details : bool;
   indent : bool;
   theme_uri : Odoc_html.Tree.uri;
+  support_uri : Odoc_html.Tree.uri;
 }
 
 let render args page =
   Odoc_html.Link.semantic_uris := args.semantic_uris;
   Odoc_html.Tree.open_details := not args.closed_details;
-  Odoc_html.Generator.render ~theme_uri:args.theme_uri ~indent:args.indent page
+  Odoc_html.Generator.render ~theme_uri:args.theme_uri
+    ~support_uri:args.support_uri ~indent:args.indent page
 
 let files_of_url url = [ Odoc_html.Link.Path.as_filename url ]
 
diff --git a/src/odoc/html_page.mli b/src/odoc/html_page.mli
index e3471a6404..038c29f19c 100644
--- a/src/odoc/html_page.mli
+++ b/src/odoc/html_page.mli
@@ -21,6 +21,7 @@ type args = {
   closed_details : bool;
   indent : bool;
   theme_uri : Odoc_html.Tree.uri;
+  support_uri : Odoc_html.Tree.uri;
 }
 
 val renderer : args Renderer.t

From fc7f953e2c6bd7fb300df181c7054d2d3e540863 Mon Sep 17 00:00:00 2001
From: Jon Ludlam <jon@recoil.org>
Date: Mon, 24 May 2021 23:09:40 +0100
Subject: [PATCH 02/13] Add flat HTML output mode

---
 src/html/link.ml  | 33 +++++++++++++++++++++++--------
 src/html/link.mli |  4 ++++
 src/html/tree.ml  | 50 ++++++++++++++++++++++++++---------------------
 3 files changed, 57 insertions(+), 30 deletions(-)

diff --git a/src/html/link.ml b/src/html/link.ml
index e1decf8240..f2c49a1fc5 100644
--- a/src/html/link.ml
+++ b/src/html/link.ml
@@ -1,5 +1,7 @@
 module Url = Odoc_document.Url
 
+let flat = ref true
+
 (* Translation from Url.Path *)
 module Path = struct
   let to_list url =
@@ -10,6 +12,13 @@ module Path = struct
     in
     loop [] url
 
+  let of_list l =
+    let rec inner parent = function
+      | [] -> parent
+      | (kind, name) :: xs -> inner (Some { Url.Path.parent; name; kind }) xs
+    in
+    inner None l
+
   let for_printing url = List.map snd @@ to_list url
 
   let segment_to_string (kind, name) =
@@ -21,17 +30,25 @@ module Path = struct
     url.Url.Path.kind = "page" || url.Url.Path.kind = "file"
 
   let rec get_dir { Url.Path.parent; name; kind } =
-    let ppath = match parent with Some p -> get_dir p | None -> [] in
-    match kind with
-    | "page" | "file" -> ppath
-    | _ -> ppath @ [ segment_to_string (kind, name) ]
+    if !flat then []
+    else
+      let ppath = match parent with Some p -> get_dir p | None -> [] in
+      match kind with
+      | "page" | "file" -> ppath
+      | _ -> ppath @ [ segment_to_string (kind, name) ]
 
   let get_file : Url.Path.t -> string =
    fun t ->
-    match t.kind with
-    | "page" -> t.name ^ ".html"
-    | "file" -> t.name
-    | _ -> "index.html"
+    if !flat then
+      match t.kind with
+      | "file" -> t.name
+      | _ ->
+          String.concat "-" (List.map segment_to_string (to_list t)) ^ ".html"
+    else
+      match t.kind with
+      | "page" -> t.name ^ ".html"
+      | "file" -> t.name
+      | _ -> "index.html"
 
   let for_linking : Url.Path.t -> string list =
    fun url -> get_dir url @ [ get_file url ]
diff --git a/src/html/link.mli b/src/html/link.mli
index 1e38ef7154..c5b34706fb 100644
--- a/src/html/link.mli
+++ b/src/html/link.mli
@@ -10,6 +10,10 @@ type resolve = Current of Url.Path.t | Base of string
 val href : resolve:resolve -> Url.t -> string
 
 module Path : sig
+  val to_list : Url.Path.t -> (string * string) list
+
+  val of_list : (string * string) list -> Url.Path.t option
+
   val is_leaf_page : Url.Path.t -> bool
 
   val for_printing : Url.Path.t -> string list
diff --git a/src/html/tree.ml b/src/html/tree.ml
index ab44da4007..4c59e5c608 100644
--- a/src/html/tree.ml
+++ b/src/html/tree.ml
@@ -20,11 +20,7 @@ type uri = Absolute of string | Relative of Odoc_document.Url.Path.t option
 
 let page_creator ?(theme_uri = Relative None) ?(support_uri = Relative None)
     ~url name header toc content =
-  let is_leaf_page = Link.Path.is_leaf_page url in
   let path = Link.Path.for_printing url in
-  let rec add_dotdot ~n acc =
-    if n <= 0 then acc else add_dotdot ~n:(n - 1) ("../" ^ acc)
-  in
 
   let head : Html_types.head Html.elt =
     let title_string = Printf.sprintf "%s (%s)" name (String.concat "." path) in
@@ -64,33 +60,43 @@ let page_creator ?(theme_uri = Relative None) ?(support_uri = Relative None)
   in
 
   let breadcrumbs =
-    let dot = if !Link.semantic_uris then "" else "index.html" in
-    let dotdot = add_dotdot ~n:1 dot in
-    let up_href = if is_leaf_page && name <> "index" then dot else dotdot in
-    let has_parent = List.length path > 1 in
+    let rec get_parents x =
+      match x with
+      | [] -> []
+      | x :: xs -> (
+          match Link.Path.of_list (List.rev (x :: xs)) with
+          | Some x -> x :: get_parents xs
+          | None -> get_parents xs)
+    in
+    let parents = get_parents (List.rev (Link.Path.to_list url)) |> List.rev in
+    let has_parent = List.length parents > 1 in
+    let href page =
+      Link.href ~resolve:(Current url)
+        Odoc_document.Url.Anchor.{ page; anchor = ""; kind = "" }
+    in
     if has_parent then
+      let up_url = List.hd (List.tl (List.rev parents)) in
       let l =
         [
-          Html.a ~a:[ Html.a_href up_href ] [ Html.txt "Up" ]; Html.txt " – ";
+          Html.a ~a:[ Html.a_href (href up_url) ] [ Html.txt "Up" ];
+          Html.txt " – ";
         ]
         @
         (* Create breadcrumbs *)
         let space = Html.txt " " in
-        let breadcrumb_spec =
-          if is_leaf_page then fun n x -> (n, dot, x)
-          else fun n x -> (n, add_dotdot ~n dot, x)
-        in
-        let rev_path =
-          if is_leaf_page && name = "index" then List.tl (List.rev path)
-          else List.rev path
-        in
-        rev_path |> List.mapi breadcrumb_spec |> List.rev
+        parents
         |> Utils.list_concat_map
              ?sep:(Some [ space; Html.entity "#x00BB"; space ])
-             ~f:(fun (n, addr, lbl) ->
-               if n > 0 then
-                 [ [ Html.a ~a:[ Html.a_href addr ] [ Html.txt lbl ] ] ]
-               else [ [ Html.txt lbl ] ])
+             ~f:(fun url' ->
+               [
+                 [
+                   (if url = url' then Html.txt url.name
+                   else
+                     Html.a
+                       ~a:[ Html.a_href (href url') ]
+                       [ Html.txt url'.name ]);
+                 ];
+               ])
         |> List.flatten
       in
       [ Html.nav ~a:[ Html.a_class [ "odoc-nav" ] ] l ]

From 89e06663efcf07277a0135c826fd71dd1e848b05 Mon Sep 17 00:00:00 2001
From: Jon Ludlam <jon@recoil.org>
Date: Mon, 24 May 2021 23:23:00 +0100
Subject: [PATCH 03/13] Add support for flat HTML output

---
 src/html/link.ml       |  2 +-
 src/html/link.mli      |  2 ++
 src/odoc/bin/main.ml   | 12 ++++++++++--
 src/odoc/html_page.ml  |  2 ++
 src/odoc/html_page.mli |  1 +
 5 files changed, 16 insertions(+), 3 deletions(-)

diff --git a/src/html/link.ml b/src/html/link.ml
index f2c49a1fc5..7894f93ee0 100644
--- a/src/html/link.ml
+++ b/src/html/link.ml
@@ -1,6 +1,6 @@
 module Url = Odoc_document.Url
 
-let flat = ref true
+let flat = ref false
 
 (* Translation from Url.Path *)
 module Path = struct
diff --git a/src/html/link.mli b/src/html/link.mli
index c5b34706fb..dba8fb9979 100644
--- a/src/html/link.mli
+++ b/src/html/link.mli
@@ -2,6 +2,8 @@
 
 module Url = Odoc_document.Url
 
+val flat : bool ref
+
 val semantic_uris : bool ref
 (** Whether to generate pretty/semantics links or not. *)
 
diff --git a/src/odoc/bin/main.ml b/src/odoc/bin/main.ml
index 383373baff..c57f021913 100644
--- a/src/odoc/bin/main.ml
+++ b/src/odoc/bin/main.ml
@@ -407,6 +407,13 @@ module Odoc_html = Make_renderer (struct
     in
     Arg.(value & flag (info ~doc [ "closed-details" ]))
 
+  let flat_output =
+    let doc =
+      "Output the resulting HTML files into one directory rather than a \
+       hierarchy"
+    in
+    Arg.(value & flag (info ~doc [ "flat" ]))
+
   let indent =
     let doc = "Format the output HTML files with indentation" in
     Arg.(value & flag (info ~doc [ "indent" ]))
@@ -466,18 +473,19 @@ module Odoc_html = Make_renderer (struct
       value & opt convert_uri default & info ~docv:"URI" ~doc [ "support-uri" ])
 
   let extra_args =
-    let f semantic_uris closed_details indent theme_uri support_uri =
+    let f semantic_uris closed_details indent theme_uri support_uri flat =
       {
         Html_page.semantic_uris;
         closed_details;
         theme_uri;
         support_uri;
         indent;
+        flat;
       }
     in
     Term.(
       const f $ semantic_uris $ closed_details $ indent $ theme_uri
-      $ support_uri)
+      $ support_uri $ flat_output)
 end)
 
 module Html_fragment : sig
diff --git a/src/odoc/html_page.ml b/src/odoc/html_page.ml
index d04fb306fc..b8152d1906 100644
--- a/src/odoc/html_page.ml
+++ b/src/odoc/html_page.ml
@@ -22,11 +22,13 @@ type args = {
   indent : bool;
   theme_uri : Odoc_html.Tree.uri;
   support_uri : Odoc_html.Tree.uri;
+  flat : bool;
 }
 
 let render args page =
   Odoc_html.Link.semantic_uris := args.semantic_uris;
   Odoc_html.Tree.open_details := not args.closed_details;
+  Odoc_html.Link.flat := args.flat;
   Odoc_html.Generator.render ~theme_uri:args.theme_uri
     ~support_uri:args.support_uri ~indent:args.indent page
 
diff --git a/src/odoc/html_page.mli b/src/odoc/html_page.mli
index 038c29f19c..86dc815b24 100644
--- a/src/odoc/html_page.mli
+++ b/src/odoc/html_page.mli
@@ -22,6 +22,7 @@ type args = {
   indent : bool;
   theme_uri : Odoc_html.Tree.uri;
   support_uri : Odoc_html.Tree.uri;
+  flat : bool;
 }
 
 val renderer : args Renderer.t

From 8d7fe88e2b5e92409884f55ebca0d5d604e85261 Mon Sep 17 00:00:00 2001
From: Jon Ludlam <jon@recoil.org>
Date: Mon, 14 Jun 2021 14:06:38 +0100
Subject: [PATCH 04/13] Add support for arbitrary suffixes for tests

---
 src/html/generator.ml  | 20 ++++++++++----------
 src/html/generator.mli |  1 +
 src/html/tree.ml       |  6 +++---
 src/html/tree.mli      |  1 +
 src/odoc/bin/main.ml   | 15 +++++++++++++--
 src/odoc/html_page.ml  |  4 +++-
 src/odoc/html_page.mli |  1 +
 7 files changed, 32 insertions(+), 16 deletions(-)

diff --git a/src/html/generator.ml b/src/html/generator.ml
index 8e33dd47d6..4eb66ef5dd 100644
--- a/src/html/generator.ml
+++ b/src/html/generator.ml
@@ -370,30 +370,30 @@ module Page = struct
         | `Closed | `Open | `Default -> None
         | `Inline -> Some 0)
 
-  let rec include_ ?theme_uri indent { Subpage.content; _ } =
-    [ page ?theme_uri indent content ]
+  let rec include_ ?theme_uri extra_suffix indent { Subpage.content; _ } =
+    [ page ?theme_uri extra_suffix indent content ]
 
-  and subpages ?theme_uri indent i =
-    Utils.list_concat_map ~f:(include_ ?theme_uri indent)
+  and subpages ?theme_uri extra_suffix indent i =
+    Utils.list_concat_map ~f:(include_ ?theme_uri extra_suffix indent)
     @@ Doctree.Subpages.compute i
 
-  and page ?theme_uri ?support_uri indent
+  and page ?theme_uri ?support_uri extra_suffix indent
       ({ Page.title; header; items = i; url } as p) =
     let resolve = Link.Current url in
     let i = Doctree.Shift.compute ~on_sub i in
     let toc = Toc.from_items ~resolve ~path:url i in
-    let subpages = subpages ?theme_uri indent p in
+    let subpages = subpages ?theme_uri extra_suffix indent p in
     let header = items ~resolve header in
     let content = (items ~resolve i :> any Html.elt list) in
     let page =
-      Tree.make ?theme_uri ?support_uri ~indent ~header ~toc ~url title content
-        subpages
+      Tree.make ?theme_uri ?support_uri ~indent ~header ~toc ~url ~extra_suffix
+        title content subpages
     in
     page
 end
 
-let render ?theme_uri ?support_uri ~indent page =
-  Page.page ?theme_uri ?support_uri indent page
+let render ?theme_uri ?support_uri ~indent ~extra_suffix page =
+  Page.page ?theme_uri ?support_uri extra_suffix indent page
 
 let doc ~xref_base_uri b =
   let resolve = Link.Base xref_base_uri in
diff --git a/src/html/generator.mli b/src/html/generator.mli
index 586e8cee0f..ca91b23c98 100644
--- a/src/html/generator.mli
+++ b/src/html/generator.mli
@@ -4,6 +4,7 @@ val render :
   ?theme_uri:Tree.uri ->
   ?support_uri:Tree.uri ->
   indent:bool ->
+  extra_suffix:string ->
   Types.Page.t ->
   Renderer.page
 
diff --git a/src/html/tree.ml b/src/html/tree.ml
index 4c59e5c608..33c407ab62 100644
--- a/src/html/tree.ml
+++ b/src/html/tree.ml
@@ -111,9 +111,9 @@ let page_creator ?(theme_uri = Relative None) ?(support_uri = Relative None)
   in
   Html.html head (Html.body ~a:[ Html.a_class [ "odoc" ] ] body)
 
-let make ?theme_uri ?support_uri ~indent ~url ~header ~toc title content
-    children =
-  let filename = Link.Path.as_filename url in
+let make ?theme_uri ?support_uri ~indent ~url ~header ~extra_suffix ~toc title
+    content children =
+  let filename = Fpath.add_ext extra_suffix (Link.Path.as_filename url) in
   let html =
     page_creator ?theme_uri ?support_uri ~url title header toc content
   in
diff --git a/src/html/tree.mli b/src/html/tree.mli
index 15e6ac5bee..e3639d781f 100644
--- a/src/html/tree.mli
+++ b/src/html/tree.mli
@@ -33,6 +33,7 @@ val make :
   indent:bool ->
   url:Url.Path.t ->
   header:Html_types.flow5_without_header_footer Html.elt list ->
+  extra_suffix:string ->
   toc:Html_types.flow5 Html.elt list ->
   string ->
   Html_types.div_content Html.elt list ->
diff --git a/src/odoc/bin/main.ml b/src/odoc/bin/main.ml
index c57f021913..83dac5eb1d 100644
--- a/src/odoc/bin/main.ml
+++ b/src/odoc/bin/main.ml
@@ -472,8 +472,18 @@ module Odoc_html = Make_renderer (struct
     Arg.(
       value & opt convert_uri default & info ~docv:"URI" ~doc [ "support-uri" ])
 
+  let extra_suffix =
+    let doc =
+      "Extra suffix to append to generated filenames. This is intended for \
+       expect tests to use."
+    in
+    let default = "" in
+    Arg.(
+      value & opt string default & info ~docv:"SUFFIX" ~doc [ "extra-suffix" ])
+
   let extra_args =
-    let f semantic_uris closed_details indent theme_uri support_uri flat =
+    let f semantic_uris closed_details indent theme_uri support_uri flat
+        extra_suffix =
       {
         Html_page.semantic_uris;
         closed_details;
@@ -481,11 +491,12 @@ module Odoc_html = Make_renderer (struct
         support_uri;
         indent;
         flat;
+        extra_suffix;
       }
     in
     Term.(
       const f $ semantic_uris $ closed_details $ indent $ theme_uri
-      $ support_uri $ flat_output)
+      $ support_uri $ flat_output $ extra_suffix)
 end)
 
 module Html_fragment : sig
diff --git a/src/odoc/html_page.ml b/src/odoc/html_page.ml
index b8152d1906..d65afe4733 100644
--- a/src/odoc/html_page.ml
+++ b/src/odoc/html_page.ml
@@ -23,6 +23,7 @@ type args = {
   theme_uri : Odoc_html.Tree.uri;
   support_uri : Odoc_html.Tree.uri;
   flat : bool;
+  extra_suffix : string;
 }
 
 let render args page =
@@ -30,7 +31,8 @@ let render args page =
   Odoc_html.Tree.open_details := not args.closed_details;
   Odoc_html.Link.flat := args.flat;
   Odoc_html.Generator.render ~theme_uri:args.theme_uri
-    ~support_uri:args.support_uri ~indent:args.indent page
+    ~support_uri:args.support_uri ~indent:args.indent
+    ~extra_suffix:args.extra_suffix page
 
 let files_of_url url = [ Odoc_html.Link.Path.as_filename url ]
 
diff --git a/src/odoc/html_page.mli b/src/odoc/html_page.mli
index 86dc815b24..d8032d5379 100644
--- a/src/odoc/html_page.mli
+++ b/src/odoc/html_page.mli
@@ -23,6 +23,7 @@ type args = {
   theme_uri : Odoc_html.Tree.uri;
   support_uri : Odoc_html.Tree.uri;
   flat : bool;
+  extra_suffix : string;
 }
 
 val renderer : args Renderer.t

From 043d4a9119ef7171303578c958441351b58ecffe Mon Sep 17 00:00:00 2001
From: lubegasimon <lubegasimon73@gmail.com>
Date: Fri, 25 Jun 2021 13:30:14 +0300
Subject: [PATCH 05/13] enable --flat flag for latex backend

---
 src/document/url.ml     | 29 +++++++++++++++++++++++++++
 src/html/link.ml        |  2 +-
 src/latex/generator.ml  | 44 +++++++++++++++++++++--------------------
 src/latex/generator.mli |  1 +
 src/manpage/link.ml     |  2 +-
 src/odoc/bin/main.ml    | 18 ++++++++---------
 src/odoc/latex.ml       |  4 ++--
 7 files changed, 66 insertions(+), 34 deletions(-)

diff --git a/src/document/url.ml b/src/document/url.ml
index 2bed8fd106..f137e1572b 100644
--- a/src/document/url.ml
+++ b/src/document/url.ml
@@ -76,6 +76,35 @@ module Path = struct
 
   type t = { kind : string; parent : t option; name : string }
 
+  (* 
+  
+  If we have a module that looks like this:
+
+  {[
+    module M : sig
+      module type MT = sig
+        type t
+      end
+    end
+  ]}
+
+  and this has parent page 'toppage', then the Path.t for module type MT will look like this:
+
+  { kind="module-type";
+    name="MT";
+    parent=Some {
+      kind="module";
+      name="M";
+      parent = Some {
+        kind="container-page";
+        name="toppage"
+        parent=None;
+      }
+    }
+  }
+
+  *)
+
   let mk ?parent kind name = { kind; parent; name }
 
   let rec from_identifier : source -> t = function
diff --git a/src/html/link.ml b/src/html/link.ml
index 7894f93ee0..f2c49a1fc5 100644
--- a/src/html/link.ml
+++ b/src/html/link.ml
@@ -1,6 +1,6 @@
 module Url = Odoc_document.Url
 
-let flat = ref false
+let flat = ref true
 
 (* Translation from Url.Path *)
 module Path = struct
diff --git a/src/latex/generator.ml b/src/latex/generator.ml
index 3abb962e8b..5b8a3e53f5 100644
--- a/src/latex/generator.ml
+++ b/src/latex/generator.ml
@@ -46,10 +46,10 @@ module Link = struct
         | "container-page" -> Fpath.(pdir / url.name)
         | _ -> pdir)
 
-  let file url =
+  let file ~flat url =
     let rec l (url : Odoc_document.Url.Path.t) acc =
       match url.kind with
-      | "container-page" -> acc
+      | "container-page" when not flat -> acc
       | _ -> (
           match url.parent with
           | None ->
@@ -57,14 +57,16 @@ module Link = struct
               (* Only container-pages are allowed to have no parent *)
           | Some p -> l p (url.name :: acc))
     in
-    String.concat "." (l url [])
-
-  let filename url =
-    let dir = dir url in
-    let file = file url in
-    Format.eprintf "dir=%a file=%s\n%!" Fpath.pp dir file;
-    if file = "" then Fpath.add_ext "tex" dir
-    else Fpath.(add_ext "tex" (dir / file))
+    String.concat "." (l url []) 
+
+  let filename ~flat url =
+    let file = file ~flat url |> Fpath.v in
+    if flat
+      then Fpath.set_ext "tex" file
+    else 
+      let dir = dir url in
+      Fpath.(dir // file |> Fpath.add_ext "tex")
+
 end
 
 let style = function
@@ -438,8 +440,8 @@ module Doc = struct
     in
     Fmt.list input_child ppf children
 
-  let make ~with_children url content children =
-    let filename = Link.filename url in
+  let make ~with_children ~flat url content children =
+    let filename = Link.filename ~flat url in
     let label = Label (Link.page url) in
     let content =
       match content with
@@ -457,25 +459,25 @@ end
 module Page = struct
   let on_sub = function `Page _ -> Some 1 | `Include _ -> None
 
-  let rec subpage ~with_children (p : Subpage.t) =
+  let rec subpage ~with_children ~flat (p : Subpage.t) =
     if Link.should_inline p.status p.content.url then []
-    else [ page ~with_children p.content ]
+    else [ page ~with_children ~flat p.content ]
 
-  and subpages ~with_children i =
+  and subpages ~with_children ~flat i =
     List.flatten
-    @@ List.map (subpage ~with_children)
+    @@ List.map (subpage ~with_children ~flat)
     @@ Doctree.Subpages.compute i
 
-  and page ~with_children ({ Page.title = _; header; items = i; url } as p) =
+  and page ~with_children ~flat ({ Page.title = _; header; items = i; url } as p) =
     let i = Doctree.Shift.compute ~on_sub i in
-    let subpages = subpages ~with_children p in
+    let subpages = subpages ~with_children ~flat p in
     let header = items header in
     let content = items i in
-    let page = Doc.make ~with_children url (header @ content) subpages in
+    let page = Doc.make ~with_children ~flat url (header @ content) subpages in
     page
 end
 
-let render ~with_children page = Page.page ~with_children page
+let render ~with_children ~flat page = Page.page ~with_children ~flat page 
 
 let files_of_url url =
-  if Link.is_class_or_module_path url then [ Link.filename url ] else []
+  if Link.is_class_or_module_path url then [ Link.filename ~flat:false url ] else []
diff --git a/src/latex/generator.mli b/src/latex/generator.mli
index a96a840d1c..de8895958b 100644
--- a/src/latex/generator.mli
+++ b/src/latex/generator.mli
@@ -2,5 +2,6 @@ val files_of_url : Odoc_document.Url.Path.t -> Fpath.t list
 
 val render :
   with_children:bool ->
+  flat:bool ->
   Odoc_document.Types.Page.t ->
   Odoc_document.Renderer.page
diff --git a/src/manpage/link.ml b/src/manpage/link.ml
index 4d0f48ec59..4cf5ff580f 100644
--- a/src/manpage/link.ml
+++ b/src/manpage/link.ml
@@ -27,7 +27,7 @@ let as_filename (url : Url.Path.t) =
   in
   let dir, path = get_components url in
   let s = String.concat "." @@ List.rev path in
-  Fpath.((v dir / s) + ".3o")
+  (dir ^ "-" ^ s) ^ ".3o" |> Fpath.v
 
 let rec is_class_or_module_path (url : Url.Path.t) =
   match url.kind with
diff --git a/src/odoc/bin/main.ml b/src/odoc/bin/main.ml
index 83dac5eb1d..d029157569 100644
--- a/src/odoc/bin/main.ml
+++ b/src/odoc/bin/main.ml
@@ -55,6 +55,13 @@ let hidden =
   in
   Arg.(value & flag & info ~docs ~doc [ "hidden" ])
 
+let flat_output =
+  let doc =
+    "Output the resulting files into one directory rather than a \
+      hierarchy"
+  in
+  Arg.(value & flag (info ~doc [ "flat" ]))
+
 let warnings_options =
   let warn_error =
     let doc = "Turn warnings into errors." in
@@ -407,13 +414,6 @@ module Odoc_html = Make_renderer (struct
     in
     Arg.(value & flag (info ~doc [ "closed-details" ]))
 
-  let flat_output =
-    let doc =
-      "Output the resulting HTML files into one directory rather than a \
-       hierarchy"
-    in
-    Arg.(value & flag (info ~doc [ "flat" ]))
-
   let indent =
     let doc = "Format the output HTML files with indentation" in
     Arg.(value & flag (info ~doc [ "indent" ]))
@@ -566,8 +566,8 @@ module Odoc_latex = Make_renderer (struct
     Arg.(value & opt bool true & info ~docv:"BOOL" ~doc [ "with-children" ])
 
   let extra_args =
-    let f with_children = { Latex.with_children } in
-    Term.(const f $ with_children)
+    let f with_children flat = { Latex.with_children; flat } in
+    Term.(const f $ with_children $ flat_output)
 end)
 
 module Depends = struct
diff --git a/src/odoc/latex.ml b/src/odoc/latex.ml
index d7c4568e5c..c75aba3061 100644
--- a/src/odoc/latex.ml
+++ b/src/odoc/latex.ml
@@ -1,9 +1,9 @@
 open Odoc_document
 
-type args = { with_children : bool }
+type args = { with_children : bool; flat : bool }
 
 let render args page =
-  Odoc_latex.Generator.render ~with_children:args.with_children page
+  Odoc_latex.Generator.render ~with_children:args.with_children page ~flat:args.flat
 
 let files_of_url url = Odoc_latex.Generator.files_of_url url
 

From 80b5571fa76dec1c77555a2a7469aa703a4ed885 Mon Sep 17 00:00:00 2001
From: lubegasimon <lubegasimon73@gmail.com>
Date: Fri, 25 Jun 2021 14:06:19 +0300
Subject: [PATCH 06/13] Fix dir calculation for latex

---
 src/latex/generator.ml | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

diff --git a/src/latex/generator.ml b/src/latex/generator.ml
index 5b8a3e53f5..c781e4164d 100644
--- a/src/latex/generator.ml
+++ b/src/latex/generator.ml
@@ -53,8 +53,9 @@ module Link = struct
       | _ -> (
           match url.parent with
           | None ->
-              assert false
-              (* Only container-pages are allowed to have no parent *)
+              (* Only container-pages are allowed to have no parent, so we must be in flat mode *)
+              assert flat;
+              acc
           | Some p -> l p (url.name :: acc))
     in
     String.concat "." (l url []) 

From 197e321456599b47f5c2d62f93ea8c8da96e0c60 Mon Sep 17 00:00:00 2001
From: lubegasimon <lubegasimon73@gmail.com>
Date: Fri, 25 Jun 2021 13:34:34 +0300
Subject: [PATCH 07/13] remove unused function - files_of_url

Signed-off-by: lubegasimon <lubegasimon73@gmail.com>
---
 src/document/renderer.ml | 1 -
 src/latex/generator.ml   | 3 ---
 src/latex/generator.mli  | 2 --
 src/manpage/link.ml      | 3 ---
 src/odoc/html_page.ml    | 4 +---
 src/odoc/latex.ml        | 4 +---
 src/odoc/man_page.ml     | 4 +---
 7 files changed, 3 insertions(+), 18 deletions(-)

diff --git a/src/document/renderer.ml b/src/document/renderer.ml
index 51c44518fb..0d91699799 100644
--- a/src/document/renderer.ml
+++ b/src/document/renderer.ml
@@ -20,7 +20,6 @@ let traverse ~f t =
 type 'a t = {
   name : string;
   render : 'a -> Types.Page.t -> page;
-  files_of_url : Url.Path.t -> Fpath.t list;
 }
 
 let document_of_page ~syntax v =
diff --git a/src/latex/generator.ml b/src/latex/generator.ml
index c781e4164d..6de62498e1 100644
--- a/src/latex/generator.ml
+++ b/src/latex/generator.ml
@@ -479,6 +479,3 @@ module Page = struct
 end
 
 let render ~with_children ~flat page = Page.page ~with_children ~flat page 
-
-let files_of_url url =
-  if Link.is_class_or_module_path url then [ Link.filename ~flat:false url ] else []
diff --git a/src/latex/generator.mli b/src/latex/generator.mli
index de8895958b..827b80a84b 100644
--- a/src/latex/generator.mli
+++ b/src/latex/generator.mli
@@ -1,5 +1,3 @@
-val files_of_url : Odoc_document.Url.Path.t -> Fpath.t list
-
 val render :
   with_children:bool ->
   flat:bool ->
diff --git a/src/manpage/link.ml b/src/manpage/link.ml
index 4cf5ff580f..4828e9a9d9 100644
--- a/src/manpage/link.ml
+++ b/src/manpage/link.ml
@@ -38,6 +38,3 @@ let rec is_class_or_module_path (url : Url.Path.t) =
   | _ -> false
 
 let should_inline x = not @@ is_class_or_module_path x
-
-let files_of_url url =
-  if is_class_or_module_path url then [ as_filename url ] else []
diff --git a/src/odoc/html_page.ml b/src/odoc/html_page.ml
index d65afe4733..bfa12d70be 100644
--- a/src/odoc/html_page.ml
+++ b/src/odoc/html_page.ml
@@ -34,6 +34,4 @@ let render args page =
     ~support_uri:args.support_uri ~indent:args.indent
     ~extra_suffix:args.extra_suffix page
 
-let files_of_url url = [ Odoc_html.Link.Path.as_filename url ]
-
-let renderer = { Renderer.name = "html"; render; files_of_url }
+let renderer = { Renderer.name = "html"; render }
diff --git a/src/odoc/latex.ml b/src/odoc/latex.ml
index c75aba3061..909dbf1ee8 100644
--- a/src/odoc/latex.ml
+++ b/src/odoc/latex.ml
@@ -5,6 +5,4 @@ type args = { with_children : bool; flat : bool }
 let render args page =
   Odoc_latex.Generator.render ~with_children:args.with_children page ~flat:args.flat
 
-let files_of_url url = Odoc_latex.Generator.files_of_url url
-
-let renderer = { Renderer.name = "latex"; render; files_of_url }
+let renderer = { Renderer.name = "latex"; render }
diff --git a/src/odoc/man_page.ml b/src/odoc/man_page.ml
index 605fc373ce..f31df9cffd 100644
--- a/src/odoc/man_page.ml
+++ b/src/odoc/man_page.ml
@@ -2,6 +2,4 @@ open Odoc_document
 
 let render _ page = Odoc_manpage.Generator.render page
 
-let files_of_url url = Odoc_manpage.Link.files_of_url url
-
-let renderer = { Renderer.name = "man"; render; files_of_url }
+let renderer = { Renderer.name = "man"; render }

From 0685bcc6db3e19039d9b45298470e6d48d4e4ddb Mon Sep 17 00:00:00 2001
From: lubegasimon <lubegasimon73@gmail.com>
Date: Fri, 25 Jun 2021 16:30:22 +0300
Subject: [PATCH 08/13] a few modifications

---
 commits-to-take        | 2 ++
 src/latex/generator.ml | 7 ++++---
 src/manpage/link.ml    | 2 +-
 3 files changed, 7 insertions(+), 4 deletions(-)
 create mode 100644 commits-to-take

diff --git a/commits-to-take b/commits-to-take
new file mode 100644
index 0000000000..2873cc80ae
--- /dev/null
+++ b/commits-to-take
@@ -0,0 +1,2 @@
+bea122919d799 d6ef4ca0f0a2cf6d74
+59d171ed
diff --git a/src/latex/generator.ml b/src/latex/generator.ml
index 6de62498e1..0a86f2151a 100644
--- a/src/latex/generator.ml
+++ b/src/latex/generator.ml
@@ -55,15 +55,16 @@ module Link = struct
           | None ->
               (* Only container-pages are allowed to have no parent, so we must be in flat mode *)
               assert flat;
-              acc
+              url.name :: acc
           | Some p -> l p (url.name :: acc))
     in
-    String.concat "." (l url []) 
+    let result = (l url []) in
+    String.concat "." result
 
   let filename ~flat url =
     let file = file ~flat url |> Fpath.v in
     if flat
-      then Fpath.set_ext "tex" file
+      then Fpath.add_ext "tex" file
     else 
       let dir = dir url in
       Fpath.(dir // file |> Fpath.add_ext "tex")
diff --git a/src/manpage/link.ml b/src/manpage/link.ml
index 4828e9a9d9..6b2e65cffd 100644
--- a/src/manpage/link.ml
+++ b/src/manpage/link.ml
@@ -27,7 +27,7 @@ let as_filename (url : Url.Path.t) =
   in
   let dir, path = get_components url in
   let s = String.concat "." @@ List.rev path in
-  (dir ^ "-" ^ s) ^ ".3o" |> Fpath.v
+  Fpath.((v dir / s) + ".3o")
 
 let rec is_class_or_module_path (url : Url.Path.t) =
   match url.kind with

From de44b6fddaacbc59dbfd6234a0a728b8439feef8 Mon Sep 17 00:00:00 2001
From: lubegasimon <lubegasimon73@gmail.com>
Date: Sat, 26 Jun 2021 12:31:47 +0300
Subject: [PATCH 09/13] enable '--extra-suffix' flag in latex backend

Signed-off-by: lubegasimon <lubegasimon73@gmail.com>
---
 src/latex/generator.ml  | 20 ++++++++++----------
 src/latex/generator.mli |  1 +
 src/odoc/bin/main.ml    | 22 +++++++++++-----------
 src/odoc/latex.ml       |  4 ++--
 4 files changed, 24 insertions(+), 23 deletions(-)

diff --git a/src/latex/generator.ml b/src/latex/generator.ml
index 0a86f2151a..2194d96df3 100644
--- a/src/latex/generator.ml
+++ b/src/latex/generator.ml
@@ -442,8 +442,8 @@ module Doc = struct
     in
     Fmt.list input_child ppf children
 
-  let make ~with_children ~flat url content children =
-    let filename = Link.filename ~flat url in
+  let make ~with_children ~flat ~extra_suffix url content children =
+    let filename = Link.filename ~flat url |> Fpath.add_ext extra_suffix in
     let label = Label (Link.page url) in
     let content =
       match content with
@@ -461,22 +461,22 @@ end
 module Page = struct
   let on_sub = function `Page _ -> Some 1 | `Include _ -> None
 
-  let rec subpage ~with_children ~flat (p : Subpage.t) =
+  let rec subpage ~with_children ~flat ~extra_suffix (p : Subpage.t) =
     if Link.should_inline p.status p.content.url then []
-    else [ page ~with_children ~flat p.content ]
+    else [ page ~with_children ~flat ~extra_suffix p.content ]
 
-  and subpages ~with_children ~flat i =
+  and subpages ~with_children ~flat ~extra_suffix i =
     List.flatten
-    @@ List.map (subpage ~with_children ~flat)
+    @@ List.map (subpage ~with_children ~flat ~extra_suffix)
     @@ Doctree.Subpages.compute i
 
-  and page ~with_children ~flat ({ Page.title = _; header; items = i; url } as p) =
+  and page ~with_children ~flat ~extra_suffix ({ Page.title = _; header; items = i; url } as p) =
     let i = Doctree.Shift.compute ~on_sub i in
-    let subpages = subpages ~with_children ~flat p in
+    let subpages = subpages ~with_children ~flat ~extra_suffix p in
     let header = items header in
     let content = items i in
-    let page = Doc.make ~with_children ~flat url (header @ content) subpages in
+    let page = Doc.make ~with_children ~flat ~extra_suffix url (header @ content) subpages in
     page
 end
 
-let render ~with_children ~flat page = Page.page ~with_children ~flat page 
+let render ~with_children ~flat ~extra_suffix page = Page.page ~with_children ~flat ~extra_suffix page 
diff --git a/src/latex/generator.mli b/src/latex/generator.mli
index 827b80a84b..fcd110e770 100644
--- a/src/latex/generator.mli
+++ b/src/latex/generator.mli
@@ -1,5 +1,6 @@
 val render :
   with_children:bool ->
   flat:bool ->
+  extra_suffix:string ->
   Odoc_document.Types.Page.t ->
   Odoc_document.Renderer.page
diff --git a/src/odoc/bin/main.ml b/src/odoc/bin/main.ml
index d029157569..234c30ca57 100644
--- a/src/odoc/bin/main.ml
+++ b/src/odoc/bin/main.ml
@@ -62,6 +62,15 @@ let flat_output =
   in
   Arg.(value & flag (info ~doc [ "flat" ]))
 
+let extra_suffix =
+  let doc =
+    "Extra suffix to append to generated filenames. This is intended for \
+      expect tests to use."
+  in
+  let default = "" in
+  Arg.(
+    value & opt string default & info ~docv:"SUFFIX" ~doc [ "extra-suffix" ])
+
 let warnings_options =
   let warn_error =
     let doc = "Turn warnings into errors." in
@@ -472,15 +481,6 @@ module Odoc_html = Make_renderer (struct
     Arg.(
       value & opt convert_uri default & info ~docv:"URI" ~doc [ "support-uri" ])
 
-  let extra_suffix =
-    let doc =
-      "Extra suffix to append to generated filenames. This is intended for \
-       expect tests to use."
-    in
-    let default = "" in
-    Arg.(
-      value & opt string default & info ~docv:"SUFFIX" ~doc [ "extra-suffix" ])
-
   let extra_args =
     let f semantic_uris closed_details indent theme_uri support_uri flat
         extra_suffix =
@@ -566,8 +566,8 @@ module Odoc_latex = Make_renderer (struct
     Arg.(value & opt bool true & info ~docv:"BOOL" ~doc [ "with-children" ])
 
   let extra_args =
-    let f with_children flat = { Latex.with_children; flat } in
-    Term.(const f $ with_children $ flat_output)
+    let f with_children flat extra_suffix = { Latex.with_children; flat; extra_suffix } in
+    Term.(const f $ with_children $ flat_output $ extra_suffix)
 end)
 
 module Depends = struct
diff --git a/src/odoc/latex.ml b/src/odoc/latex.ml
index 909dbf1ee8..cf9e671d6b 100644
--- a/src/odoc/latex.ml
+++ b/src/odoc/latex.ml
@@ -1,8 +1,8 @@
 open Odoc_document
 
-type args = { with_children : bool; flat : bool }
+type args = { with_children : bool; flat : bool; extra_suffix : string }
 
 let render args page =
-  Odoc_latex.Generator.render ~with_children:args.with_children page ~flat:args.flat
+  Odoc_latex.Generator.render ~with_children:args.with_children page ~flat:args.flat ~extra_suffix:args.extra_suffix
 
 let renderer = { Renderer.name = "latex"; render }

From 60ccebf95341b7e0c339abe43de08dd69db40f8f Mon Sep 17 00:00:00 2001
From: lubegasimon <lubegasimon73@gmail.com>
Date: Mon, 28 Jun 2021 08:52:00 +0300
Subject: [PATCH 10/13] add '--flat' and '--extra-suffix' to manpages backend

Signed-off-by: lubegasimon <lubegasimon73@gmail.com>
---
 src/manpage/generator.ml  | 11 ++++++-----
 src/manpage/generator.mli |  2 +-
 src/manpage/link.ml       | 18 +++++++++++-------
 src/odoc/bin/main.ml      |  6 ++++--
 src/odoc/man_page.ml      |  7 +++++--
 5 files changed, 27 insertions(+), 17 deletions(-)

diff --git a/src/manpage/generator.ml b/src/manpage/generator.ml
index 524dd2f453..57f63c3f9e 100644
--- a/src/manpage/generator.ml
+++ b/src/manpage/generator.ml
@@ -483,12 +483,13 @@ let page { Page.title; header; items = i; url } =
   ++ macro "SH" "Documentation" ++ vspace ++ macro "nf" ""
   ++ item ~nested:false i
 
-let rec subpage subp =
+let rec subpage ~flat ~extra_suffix subp =
   let p = subp.Subpage.content in
-  if Link.should_inline p.url then [] else [ render p ]
+  if Link.should_inline p.url then [] else [ render ~flat ~extra_suffix p]
 
-and render (p : Page.t) =
+and render ~flat ~extra_suffix (p : Page.t) =
   let content ppf = Format.fprintf ppf "%a@." Roff.pp (page p) in
-  let children = Utils.flatmap ~f:subpage @@ Subpages.compute p in
-  let filename = Link.as_filename p.url in
+  let children = List.map (fun r -> subpage ~flat ~extra_suffix r) (Subpages.compute p)
+    |> List.concat in
+  let filename = Link.as_filename ~flat p.url |> Fpath.add_ext extra_suffix in
   { Renderer.filename; content; children }
diff --git a/src/manpage/generator.mli b/src/manpage/generator.mli
index 3d87bdb3f1..6b7d3072ba 100644
--- a/src/manpage/generator.mli
+++ b/src/manpage/generator.mli
@@ -1 +1 @@
-val render : Odoc_document.Types.Page.t -> Odoc_document.Renderer.page
+val render: flat: bool -> extra_suffix: string -> Odoc_document.Types.Page.t -> Odoc_document.Renderer.page
diff --git a/src/manpage/link.ml b/src/manpage/link.ml
index 6b2e65cffd..0479510075 100644
--- a/src/manpage/link.ml
+++ b/src/manpage/link.ml
@@ -17,17 +17,21 @@ let segment_to_string (kind, name) =
   then name
   else Printf.sprintf "%s-%s" kind name
 
-let as_filename (url : Url.Path.t) =
-  let rec get_components { Url.Path.parent; name; kind } =
+let as_filename ~flat (url : Url.Path.t) =
+  let rec get_components { Url.Path.parent; name; kind } acc =
     match parent with
-    | None -> (name, [])
+    | None -> assert flat; (name, name :: acc)
     | Some p ->
-        let dir, path = get_components p in
-        (dir, segment_to_string (kind, name) :: path)
+        let dir, path = get_components p [] in
+        (dir, segment_to_string (kind, name) :: (name :: path))
   in
-  let dir, path = get_components url in
+  let dir, path = get_components url [] in
   let s = String.concat "." @@ List.rev path in
-  Fpath.((v dir / s) + ".3o")
+  let file = Fpath.v s in
+  if flat
+    then Fpath.add_ext ".3o" file
+  else
+    Fpath.(v dir // file |> Fpath.add_ext ".3o")
 
 let rec is_class_or_module_path (url : Url.Path.t) =
   match url.kind with
diff --git a/src/odoc/bin/main.ml b/src/odoc/bin/main.ml
index 234c30ca57..294b2ef0ab 100644
--- a/src/odoc/bin/main.ml
+++ b/src/odoc/bin/main.ml
@@ -549,11 +549,13 @@ end = struct
 end
 
 module Odoc_manpage = Make_renderer (struct
-  type args = unit
+  type args = Man_page.args
 
   let renderer = Man_page.renderer
 
-  let extra_args = Term.const ()
+  let extra_args = 
+    let f flat extra_suffix = { Man_page.flat; extra_suffix } in
+    Term.(const f $ flat_output $ extra_suffix)
 end)
 
 module Odoc_latex = Make_renderer (struct
diff --git a/src/odoc/man_page.ml b/src/odoc/man_page.ml
index f31df9cffd..613ec1ad43 100644
--- a/src/odoc/man_page.ml
+++ b/src/odoc/man_page.ml
@@ -1,5 +1,8 @@
 open Odoc_document
 
-let render _ page = Odoc_manpage.Generator.render page
+type args = { flat : bool; extra_suffix : string }
 
-let renderer = { Renderer.name = "man"; render }
+let render args page =
+  Odoc_manpage.Generator.render page ~flat:args.flat ~extra_suffix:args.extra_suffix
+
+let renderer = { Renderer.name = "man"; render}

From ca75c9a463ade714ef45122f47ca992c77f39bb4 Mon Sep 17 00:00:00 2001
From: lubegasimon <lubegasimon73@gmail.com>
Date: Mon, 28 Jun 2021 08:53:28 +0300
Subject: [PATCH 11/13] remove comment

Signed-off-by: lubegasimon <lubegasimon73@gmail.com>
---
 src/document/url.ml | 29 -----------------------------
 1 file changed, 29 deletions(-)

diff --git a/src/document/url.ml b/src/document/url.ml
index f137e1572b..2bed8fd106 100644
--- a/src/document/url.ml
+++ b/src/document/url.ml
@@ -76,35 +76,6 @@ module Path = struct
 
   type t = { kind : string; parent : t option; name : string }
 
-  (* 
-  
-  If we have a module that looks like this:
-
-  {[
-    module M : sig
-      module type MT = sig
-        type t
-      end
-    end
-  ]}
-
-  and this has parent page 'toppage', then the Path.t for module type MT will look like this:
-
-  { kind="module-type";
-    name="MT";
-    parent=Some {
-      kind="module";
-      name="M";
-      parent = Some {
-        kind="container-page";
-        name="toppage"
-        parent=None;
-      }
-    }
-  }
-
-  *)
-
   let mk ?parent kind name = { kind; parent; name }
 
   let rec from_identifier : source -> t = function

From bddb1cfd2de10f24f8aaf2a4464cbf2f29650851 Mon Sep 17 00:00:00 2001
From: lubegasimon <lubegasimon73@gmail.com>
Date: Mon, 28 Jun 2021 12:34:41 +0300
Subject: [PATCH 12/13] format project

Signed-off-by: lubegasimon <lubegasimon73@gmail.com>
---
 src/document/renderer.ml  |  5 +----
 src/latex/generator.ml    | 19 +++++++++++--------
 src/manpage/generator.ml  |  8 +++++---
 src/manpage/generator.mli |  6 +++++-
 src/manpage/link.ml       | 12 ++++++------
 src/odoc/bin/main.ml      | 14 +++++++-------
 src/odoc/latex.ml         |  3 ++-
 src/odoc/man_page.ml      |  5 +++--
 8 files changed, 40 insertions(+), 32 deletions(-)

diff --git a/src/document/renderer.ml b/src/document/renderer.ml
index 0d91699799..784f97ce3e 100644
--- a/src/document/renderer.ml
+++ b/src/document/renderer.ml
@@ -17,10 +17,7 @@ let traverse ~f t =
   in
   aux t
 
-type 'a t = {
-  name : string;
-  render : 'a -> Types.Page.t -> page;
-}
+type 'a t = { name : string; render : 'a -> Types.Page.t -> page }
 
 let document_of_page ~syntax v =
   match syntax with Reason -> Reason.page v | OCaml -> ML.page v
diff --git a/src/latex/generator.ml b/src/latex/generator.ml
index 2194d96df3..d30e686c4b 100644
--- a/src/latex/generator.ml
+++ b/src/latex/generator.ml
@@ -58,17 +58,15 @@ module Link = struct
               url.name :: acc
           | Some p -> l p (url.name :: acc))
     in
-    let result = (l url []) in
+    let result = l url [] in
     String.concat "." result
 
   let filename ~flat url =
     let file = file ~flat url |> Fpath.v in
-    if flat
-      then Fpath.add_ext "tex" file
-    else 
+    if flat then Fpath.add_ext "tex" file
+    else
       let dir = dir url in
       Fpath.(dir // file |> Fpath.add_ext "tex")
-
 end
 
 let style = function
@@ -470,13 +468,18 @@ module Page = struct
     @@ List.map (subpage ~with_children ~flat ~extra_suffix)
     @@ Doctree.Subpages.compute i
 
-  and page ~with_children ~flat ~extra_suffix ({ Page.title = _; header; items = i; url } as p) =
+  and page ~with_children ~flat ~extra_suffix
+      ({ Page.title = _; header; items = i; url } as p) =
     let i = Doctree.Shift.compute ~on_sub i in
     let subpages = subpages ~with_children ~flat ~extra_suffix p in
     let header = items header in
     let content = items i in
-    let page = Doc.make ~with_children ~flat ~extra_suffix url (header @ content) subpages in
+    let page =
+      Doc.make ~with_children ~flat ~extra_suffix url (header @ content)
+        subpages
+    in
     page
 end
 
-let render ~with_children ~flat ~extra_suffix page = Page.page ~with_children ~flat ~extra_suffix page 
+let render ~with_children ~flat ~extra_suffix page =
+  Page.page ~with_children ~flat ~extra_suffix page
diff --git a/src/manpage/generator.ml b/src/manpage/generator.ml
index 57f63c3f9e..6bc736e3dd 100644
--- a/src/manpage/generator.ml
+++ b/src/manpage/generator.ml
@@ -485,11 +485,13 @@ let page { Page.title; header; items = i; url } =
 
 let rec subpage ~flat ~extra_suffix subp =
   let p = subp.Subpage.content in
-  if Link.should_inline p.url then [] else [ render ~flat ~extra_suffix p]
+  if Link.should_inline p.url then [] else [ render ~flat ~extra_suffix p ]
 
 and render ~flat ~extra_suffix (p : Page.t) =
   let content ppf = Format.fprintf ppf "%a@." Roff.pp (page p) in
-  let children = List.map (fun r -> subpage ~flat ~extra_suffix r) (Subpages.compute p)
-    |> List.concat in
+  let children =
+    List.map (fun r -> subpage ~flat ~extra_suffix r) (Subpages.compute p)
+    |> List.concat
+  in
   let filename = Link.as_filename ~flat p.url |> Fpath.add_ext extra_suffix in
   { Renderer.filename; content; children }
diff --git a/src/manpage/generator.mli b/src/manpage/generator.mli
index 6b7d3072ba..55610d9de1 100644
--- a/src/manpage/generator.mli
+++ b/src/manpage/generator.mli
@@ -1 +1,5 @@
-val render: flat: bool -> extra_suffix: string -> Odoc_document.Types.Page.t -> Odoc_document.Renderer.page
+val render :
+  flat:bool ->
+  extra_suffix:string ->
+  Odoc_document.Types.Page.t ->
+  Odoc_document.Renderer.page
diff --git a/src/manpage/link.ml b/src/manpage/link.ml
index 0479510075..4b70be971e 100644
--- a/src/manpage/link.ml
+++ b/src/manpage/link.ml
@@ -20,18 +20,18 @@ let segment_to_string (kind, name) =
 let as_filename ~flat (url : Url.Path.t) =
   let rec get_components { Url.Path.parent; name; kind } acc =
     match parent with
-    | None -> assert flat; (name, name :: acc)
+    | None ->
+        assert flat;
+        (name, name :: acc)
     | Some p ->
         let dir, path = get_components p [] in
-        (dir, segment_to_string (kind, name) :: (name :: path))
+        (dir, segment_to_string (kind, name) :: name :: path)
   in
   let dir, path = get_components url [] in
   let s = String.concat "." @@ List.rev path in
   let file = Fpath.v s in
-  if flat
-    then Fpath.add_ext ".3o" file
-  else
-    Fpath.(v dir // file |> Fpath.add_ext ".3o")
+  if flat then Fpath.add_ext ".3o" file
+  else Fpath.(v dir // file |> Fpath.add_ext ".3o")
 
 let rec is_class_or_module_path (url : Url.Path.t) =
   match url.kind with
diff --git a/src/odoc/bin/main.ml b/src/odoc/bin/main.ml
index 294b2ef0ab..739348ae55 100644
--- a/src/odoc/bin/main.ml
+++ b/src/odoc/bin/main.ml
@@ -57,19 +57,17 @@ let hidden =
 
 let flat_output =
   let doc =
-    "Output the resulting files into one directory rather than a \
-      hierarchy"
+    "Output the resulting files into one directory rather than a hierarchy"
   in
   Arg.(value & flag (info ~doc [ "flat" ]))
 
 let extra_suffix =
   let doc =
     "Extra suffix to append to generated filenames. This is intended for \
-      expect tests to use."
+     expect tests to use."
   in
   let default = "" in
-  Arg.(
-    value & opt string default & info ~docv:"SUFFIX" ~doc [ "extra-suffix" ])
+  Arg.(value & opt string default & info ~docv:"SUFFIX" ~doc [ "extra-suffix" ])
 
 let warnings_options =
   let warn_error =
@@ -553,7 +551,7 @@ module Odoc_manpage = Make_renderer (struct
 
   let renderer = Man_page.renderer
 
-  let extra_args = 
+  let extra_args =
     let f flat extra_suffix = { Man_page.flat; extra_suffix } in
     Term.(const f $ flat_output $ extra_suffix)
 end)
@@ -568,7 +566,9 @@ module Odoc_latex = Make_renderer (struct
     Arg.(value & opt bool true & info ~docv:"BOOL" ~doc [ "with-children" ])
 
   let extra_args =
-    let f with_children flat extra_suffix = { Latex.with_children; flat; extra_suffix } in
+    let f with_children flat extra_suffix =
+      { Latex.with_children; flat; extra_suffix }
+    in
     Term.(const f $ with_children $ flat_output $ extra_suffix)
 end)
 
diff --git a/src/odoc/latex.ml b/src/odoc/latex.ml
index cf9e671d6b..1b7350cf82 100644
--- a/src/odoc/latex.ml
+++ b/src/odoc/latex.ml
@@ -3,6 +3,7 @@ open Odoc_document
 type args = { with_children : bool; flat : bool; extra_suffix : string }
 
 let render args page =
-  Odoc_latex.Generator.render ~with_children:args.with_children page ~flat:args.flat ~extra_suffix:args.extra_suffix
+  Odoc_latex.Generator.render ~with_children:args.with_children page
+    ~flat:args.flat ~extra_suffix:args.extra_suffix
 
 let renderer = { Renderer.name = "latex"; render }
diff --git a/src/odoc/man_page.ml b/src/odoc/man_page.ml
index 613ec1ad43..4bae5049b3 100644
--- a/src/odoc/man_page.ml
+++ b/src/odoc/man_page.ml
@@ -3,6 +3,7 @@ open Odoc_document
 type args = { flat : bool; extra_suffix : string }
 
 let render args page =
-  Odoc_manpage.Generator.render page ~flat:args.flat ~extra_suffix:args.extra_suffix
+  Odoc_manpage.Generator.render page ~flat:args.flat
+    ~extra_suffix:args.extra_suffix
 
-let renderer = { Renderer.name = "man"; render}
+let renderer = { Renderer.name = "man"; render }

From 584bc956857bf128a54f00040a6d699046b940a2 Mon Sep 17 00:00:00 2001
From: lubegasimon <lubegasimon73@gmail.com>
Date: Tue, 29 Jun 2021 15:27:01 +0300
Subject: [PATCH 13/13] a small fix

Signed-off-by: lubegasimon <lubegasimon73@gmail.com>
---
 src/manpage/link.ml | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/src/manpage/link.ml b/src/manpage/link.ml
index 4b70be971e..f7886e580b 100644
--- a/src/manpage/link.ml
+++ b/src/manpage/link.ml
@@ -25,7 +25,7 @@ let as_filename ~flat (url : Url.Path.t) =
         (name, name :: acc)
     | Some p ->
         let dir, path = get_components p [] in
-        (dir, segment_to_string (kind, name) :: name :: path)
+        (dir, segment_to_string (kind, name) :: path)
   in
   let dir, path = get_components url [] in
   let s = String.concat "." @@ List.rev path in