Module Odoc_document.Renderer

Standard definition and types for all renderers

type syntax =
| OCaml
| Reason
val string_of_syntax : syntax -> string
type page = {
filename : Fpath.t;
content : Stdlib.Format.formatter -> unit;
children : page list;
}
val traverse : f:( Fpath.t -> ( Stdlib.Format.formatter -> unit ) -> 'a ) -> page -> unit
type 'a t = {
name : string;
render : 'a -> Types.Page.t -> page;
files_of_url : Url.Path.t -> Fpath.t list;
}
val document_of_page : syntax:syntax -> Odoc_model.Lang.Page.t -> Types.Page.t
val document_of_compilation_unit : syntax:syntax -> Odoc_model.Lang.Compilation_unit.t -> Types.Page.t