Odoc_file (reference.odoc.odoc.odoc.Odoc_odoc.Odoc

Sourcetype content =

Either a page or a module or something else.

Sourcetype t = {

}

val save_page : 
  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 : 
  Fs.File.t ->
  warnings:Odoc_model.Error.t list ->
  Odoc_model.Lang.Compilation_unit.t ->
  unit

Save a module.

val save_impl : 
  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.

Sourceval load : Fs.File.t -> (t, [> Or_error.msg ]) Or_error.result

Load an .odoc file.

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

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

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

Sourceval load_index : Fs.File.t -> (Odoc_index.t, [> Or_error.msg ]) Or_error.result

Load a .odoc-index file.

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

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

Load a .odoc-index file.

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