Module Odoc_html__.Tree

module Html = Tyxml.Html
module Paths = Odoc_model.Paths
type syntax =
| OCaml
| Reason
val string_of_syntax : syntax -> string
type t = private {
name : string;
content : [ `Html ] Html.elt;
children : t list;
}
val traverse : f:(parents:string list -> string -> [ `Html ] Html.elt -> unit) -> t -> unit
type kind = [
| `Arg
| `Mod
| `Mty
| `Class
| `Cty
| `Page
]
type uri =
| Absolute of string
| Relative of string

The type for absolute and relative URIs. The relative URIs are resolved using the HTML output directory as a target.

val enter : ?⁠kind:kind -> string -> unit
val leave : unit -> unit

Page creator

val make : ?⁠header_docs:Html_types.flow5_without_header_footer Html.elt list -> ?⁠theme_uri:uri -> Html_types.div_content Html.elt list -> t list -> t

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.

val render_fragment : Paths.Fragment.t -> string
val open_details : bool Stdlib.ref

Whether <details> tags should be opened by default or not. Default is true.