package odoc

  1. Overview
  2. Docs

Module Odoc_document.RendererSource

Standard definition and types for all renderers

Sourcetype syntax =
  1. | OCaml
  2. | Reason
Sourceval string_of_syntax : syntax -> string
Sourcetype page = {
  1. filename : Fpath.t;
  2. path : Url.Path.t;
  3. content : Format.formatter -> unit;
  4. children : page list;
}
Sourceval traverse : f:(Fpath.t -> (Format.formatter -> unit) -> 'a) -> page list -> unit
Sourcetype 'a t = {
  1. name : string;
  2. render : 'a -> Sidebar.t option -> Types.Document.t -> page list;
  3. filepath : 'a -> Url.Path.t -> Fpath.t;
}
Sourceval document_of_page : syntax:syntax -> Odoc_model.Lang.Page.t -> Types.Document.t
Sourceval documents_of_implementation : syntax:syntax -> Odoc_model.Lang.Implementation.t -> Syntax_highlighter.infos -> string -> Types.Document.t list
Sourceval document_of_compilation_unit : syntax:syntax -> Odoc_model.Lang.Compilation_unit.t -> Types.Document.t