Move HTML types into a separate module

Author: jonludlam

src/html/generator.ml

@@ -337,13 +337,7 @@ and items ~resolve l : item Html.elt list =
 
 module Toc = struct
   open Odoc_document.Doctree
-
-  type t = Tree.toc = {
-    title : Html_types.flow5_without_interactive Html.elt list;
-    title_str : string;
-    href : string;
-    children : t list;
-  }
+  open Types
 
   let on_sub : Subpage.status -> bool = function
     | `Closed | `Open | `Default -> false

src/html/generator.mli

@@ -1,13 +1,12 @@
-open Odoc_document
 
 val render :
-  ?theme_uri:Tree.uri ->
-  ?support_uri:Tree.uri ->
+  ?theme_uri:Types.uri ->
+  ?support_uri:Types.uri ->
   indent:bool ->
-  Types.Page.t ->
-  Renderer.page list
+  Odoc_document.Types.Page.t ->
+  Odoc_document.Renderer.page list
 
 val doc :
   xref_base_uri:string ->
-  Types.Block.t ->
+  Odoc_document.Types.Block.t ->
   Html_types.flow5_without_sectioning_heading_header_footer Tyxml.Html.elt list

src/html/odoc_html.ml

@@ -1,3 +1,4 @@
+module Types = Types 
 module Tree = Tree
 (** @canonical Odoc_html.Tree *)
 

src/html/tree.ml

@@ -16,16 +16,8 @@
 
 module Html = Tyxml.Html
 
-type uri = Absolute of string | Relative of Odoc_document.Url.Path.t option
-
-type toc = {
-  title : Html_types.flow5_without_interactive Html.elt list;
-  title_str : string;
-  href : string;
-  children : toc list;
-}
-
 let html_of_toc toc =
+  let open Types in
   let rec section section =
     let link = Html.a ~a:[ Html.a_href section.href ] section.title in
     match section.children with [] -> [ link ] | cs -> [ link; sections cs ]
@@ -38,7 +30,7 @@ let html_of_toc toc =
   | [] -> []
   | _ -> [ Html.nav ~a:[ Html.a_class [ "odoc-toc" ] ] [ sections toc ] ]
 
-let page_creator ?(theme_uri = Relative None) ?(support_uri = Relative None)
+let page_creator ?(theme_uri = Types.Relative None) ?(support_uri = Types.Relative None)
     ~url name header toc content =
   let path = Link.Path.for_printing url in
 
@@ -47,7 +39,7 @@ let page_creator ?(theme_uri = Relative None) ?(support_uri = Relative None)
 
     let file_uri base file =
       match base with
-      | Absolute uri -> uri ^ "/" ^ file
+      | Types.Absolute uri -> uri ^ "/" ^ file
       | Relative uri ->
           let page =
             Odoc_document.Url.Path.{ kind = `File; parent = uri; name = file }

src/html/tree.mli

@@ -14,37 +14,24 @@
  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  *)
 
-open Odoc_document
 module Html = Tyxml.Html
 
 (** Supported languages for printing code parts. *)
 
-type toc = {
-  title : Html_types.flow5_without_interactive Html.elt list;
-  title_str : string;
-  href : string;
-  children : toc list;
-}
-
-type uri =
-  | Absolute 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. *)
 
 (** {1 Page creator} *)
 
 val make :
-  ?theme_uri:uri ->
-  ?support_uri:uri ->
+  ?theme_uri:Types.uri ->
+  ?support_uri:Types.uri ->
   indent:bool ->
-  url:Url.Path.t ->
+  url:Odoc_document.Url.Path.t ->
   header:Html_types.flow5_without_header_footer Html.elt list ->
-  toc:toc list ->
+  toc:Types.toc list ->
   string ->
   Html_types.div_content Html.elt list ->
-  Renderer.page list ->
-  Renderer.page list
+  Odoc_document.Renderer.page list ->
+  Odoc_document.Renderer.page list
 (** [make ?theme_uri (body, children)] calls "the page creator" to turn [body]
     into an [[ `Html ] elt]. If [theme_uri] is provided, it will be used to
     locate the theme files, otherwise the HTML output directory is used. *)

src/html/types.ml

@@ -0,0 +1,10 @@
+(* Type definitions for the HTML renderer *)
+
+type uri = Absolute of string | Relative of Odoc_document.Url.Path.t option
+
+type toc = {
+  title : Html_types.flow5_without_interactive Tyxml.Html.elt list;
+  title_str : string;
+  href : string;
+  children : toc list;
+}

src/html/types.mli

@@ -0,0 +1,16 @@
+
+type uri =
+| Absolute 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. *)
+
+
+type toc = {
+  title : Html_types.flow5_without_interactive Tyxml.Html.elt list;
+  title_str : string;
+  href : string;
+  children : toc list;
+}
+
+

src/odoc/bin/main.ml

@@ -483,7 +483,7 @@ module Odoc_html = Make_renderer (struct
     Arg.(value & flag (info ~doc [ "indent" ]))
 
   (* Very basic validation and normalization for URI paths. *)
-  let convert_uri : Odoc_html.Tree.uri Arg.conv =
+  let convert_uri : Odoc_html.Types.uri Arg.conv =
     let parser str =
       if String.length str = 0 then `Error "invalid URI"
       else
@@ -509,12 +509,12 @@ module Odoc_html = Make_renderer (struct
             l ~init:None
         in
         `Ok
-          Odoc_html.Tree.(
+          Odoc_html.Types.(
             if is_absolute then Absolute str else Relative (conv_rel str))
     in
     let printer ppf = function
-      | Odoc_html.Tree.Absolute uri -> Format.pp_print_string ppf uri
-      | Odoc_html.Tree.Relative _uri -> Format.pp_print_string ppf ""
+      | Odoc_html.Types.Absolute uri -> Format.pp_print_string ppf uri
+      | Odoc_html.Types.Relative _uri -> Format.pp_print_string ppf ""
     in
     (parser, printer)
 
@@ -523,7 +523,7 @@ 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 None in
+    let default = Odoc_html.Types.Relative None in
     Arg.(
       value & opt convert_uri default & info ~docv:"URI" ~doc [ "theme-uri" ])
 
@@ -532,7 +532,7 @@ module Odoc_html = Make_renderer (struct
       "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
+    let default = Odoc_html.Types.Relative None in
     Arg.(
       value & opt convert_uri default & info ~docv:"URI" ~doc [ "support-uri" ])
 

src/odoc/html_page.ml

@@ -20,8 +20,8 @@ type args = {
   semantic_uris : bool;
   closed_details : bool;
   indent : bool;
-  theme_uri : Odoc_html.Tree.uri;
-  support_uri : Odoc_html.Tree.uri;
+  theme_uri : Odoc_html.Types.uri;
+  support_uri : Odoc_html.Types.uri;
   flat : bool;
 }
 

src/odoc/html_page.mli

@@ -20,8 +20,8 @@ type args = {
   semantic_uris : bool;
   closed_details : bool;
   indent : bool;
-  theme_uri : Odoc_html.Tree.uri;
-  support_uri : Odoc_html.Tree.uri;
+  theme_uri : Odoc_html.Types.uri;
+  support_uri : Odoc_html.Types.uri;
   flat : bool;
 }