Module `Odoc_document.Renderer`Source

Standard definition and types for all renderers

Sourcetype syntax =

| OCaml
| Reason

Sourceval string_of_syntax : Odoc_document.Renderer.syntax -> string

Sourcetype page = {

filename : Fpath.t;
path : Odoc_document.Url.Path.t;
content : Stdlib.Format.formatter -> unit;
children : Odoc_document.Renderer.page list;
assets : Odoc_extension_registry.asset list;
(*
Binary assets to write alongside this page
*)

}

val traverse : 
  f:
    (Fpath.t ->
      (Stdlib.Format.formatter -> unit) ->
      Odoc_extension_registry.asset list ->
      'a) ->
  Odoc_document.Renderer.page list ->
  unit

Sourcetype input =

| CU of Odoc_model.Lang.Compilation_unit.t
| Page of Odoc_model.Lang.Page.t

Sourcetype 'a t = {

name : string;
render : 'a -> Odoc_document.Sidebar.t option -> Odoc_document.Types.Document.t -> Odoc_document.Renderer.page list;
filepath : 'a -> Odoc_document.Url.Path.t -> Fpath.t;

}

Source

val document_of_page : 
  syntax:Odoc_document.Renderer.syntax ->
  Odoc_model.Lang.Page.t ->
  Odoc_document.Types.Document.t

Source

val documents_of_implementation : 
  syntax:Odoc_document.Renderer.syntax ->
  Odoc_model.Lang.Implementation.t ->
  Syntax_highlighter.infos ->
  string ->
  Odoc_document.Types.Document.t list

Source

val document_of_compilation_unit : 
  syntax:Odoc_document.Renderer.syntax ->
  Odoc_model.Lang.Compilation_unit.t ->
  Odoc_document.Types.Document.t

Module Odoc_document.RendererSource

Module `Odoc_document.Renderer`Source