Module `Odoc_odoc.Odoc_file`Source

Load and save .odoc and .odocl files.

Sourcetype content =

Either a page or a module or something else.

Sourcetype t = {

}

val save_page : 
  Odoc_odoc.Fs.File.t ->
  warnings:Odoc_model.Error.t list ->
  Odoc_model.Lang.Page.t ->
  unit

Save a page. The page- prefix is added to the file name if missing.

val save_unit : 
  Odoc_odoc.Fs.File.t ->
  warnings:Odoc_model.Error.t list ->
  Odoc_model.Lang.Compilation_unit.t ->
  unit

Save a module.

val save_impl : 
  Odoc_odoc.Fs.File.t ->
  warnings:Odoc_model.Error.t list ->
  Odoc_model.Lang.Implementation.t ->
  unit

Save an implementation. The src- prefix is added to the file name if missing.

val load : 
  Odoc_odoc.Fs.File.t ->
  (Odoc_odoc.Odoc_file.t, [> Odoc_utils.msg ]) Stdlib.result

Load an .odoc file.

val load_root : 
  Odoc_odoc.Fs.File.t ->
  (Odoc_model.Root.t, [> Odoc_utils.msg ]) Stdlib.result

Only load the root. Faster than load, used for looking up imports.

Sourceval save_index : Odoc_odoc.Fs.File.t -> Odoc_index.t -> unit

val load_index : 
  Odoc_odoc.Fs.File.t ->
  (Odoc_index.t, [> Odoc_utils.msg ]) Stdlib.result

Load a .odoc-index file.

Sourceval save_sidebar : Odoc_odoc.Fs.File.t -> Odoc_document.Sidebar.t -> unit

val load_sidebar : 
  Odoc_odoc.Fs.File.t ->
  (Odoc_document.Sidebar.t, [> Odoc_utils.msg ]) Stdlib.result

Load a .odoc-index file.

val save_asset : 
  Fpath.t ->
  warnings:Odoc_model.Error.t list ->
  Odoc_model.Lang.Asset.t ->
  unit

Module Odoc_odoc.Odoc_fileSource