package odoc

  1. Overview
  2. Docs
On This Page
  1. Page creator
package odoc
Legend:
Library
Module
Module type
Parameter
Class
Class type
module Html = Tyxml.Html
module Paths = Odoc_model.Paths

Supported languages for printing code parts.

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

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

    *)

These two functions are used to track the depth while building the tree, which is needed to produce correct links.

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 ref

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

OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct