Module `Odoc_odoc.Rendering`Source

Source

val render_odoc : 
  resolver:Odoc_odoc.Resolver.t ->
  warnings_options:Odoc_model.Error.warnings_options ->
  syntax:Odoc_document.Renderer.syntax ->
  renderer:'a Odoc_document.Renderer.t ->
  output:Odoc_odoc.Fs.directory ->
  'a ->
  Fpath.t ->
  (unit, [> Odoc_utils.msg ]) Stdlib.result

Source

val generate_odoc : 
  syntax:Odoc_document.Renderer.syntax ->
  warnings_options:Odoc_model.Error.warnings_options ->
  renderer:'a Odoc_document.Renderer.t ->
  output:Odoc_odoc.Fs.directory ->
  extra_suffix:string option ->
  sidebar:Fpath.t option ->
  'a ->
  Fpath.t ->
  (unit, [> Odoc_utils.msg ]) Stdlib.result

Source

val generate_source_odoc : 
  syntax:Odoc_document.Renderer.syntax ->
  warnings_options:Odoc_model.Error.warnings_options ->
  renderer:'a Odoc_document.Renderer.t ->
  output:Odoc_odoc.Fs.directory ->
  source_file:Fpath.t ->
  extra_suffix:string option ->
  sidebar:Fpath.t option ->
  'a ->
  Fpath.t ->
  (unit, [> Odoc_utils.msg ]) Stdlib.result

Source

val generate_asset_odoc : 
  warnings_options:Odoc_model.Error.warnings_options ->
  renderer:'a Odoc_document.Renderer.t ->
  output:Odoc_odoc.Fs.directory ->
  asset_file:Odoc_odoc.Fs.file ->
  extra_suffix:string option ->
  'a ->
  Odoc_odoc.Fs.file ->
  (unit, [> Odoc_utils.msg ]) Stdlib.result

Source

val targets_odoc : 
  resolver:Odoc_odoc.Resolver.t ->
  warnings_options:Odoc_model.Error.warnings_options ->
  syntax:Odoc_document.Renderer.syntax ->
  renderer:'a Odoc_document.Renderer.t ->
  output:Odoc_odoc.Fs.directory ->
  extra:'a ->
  Fpath.t ->
  (unit, [> Odoc_utils.msg ]) Stdlib.result

Source

val targets_source_odoc : 
  syntax:Odoc_document.Renderer.syntax ->
  warnings_options:Odoc_model.Error.warnings_options ->
  renderer:'a Odoc_document.Renderer.t ->
  output:Odoc_odoc.Fs.directory ->
  extra:'a ->
  source_file:Fpath.t ->
  Odoc_odoc.Fs.file ->
  (unit, [> Odoc_utils.msg ]) Stdlib.result

Module Odoc_odoc.RenderingSource

Module `Odoc_odoc.Rendering`Source