Odoc_file (odoc.odoc_odoc.Odoc_odoc.Odoc

Sourcetype unit_content = Odoc_model.Lang.Compilation_unit.t

Sourcetype content =

Either a page or a module.

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_source_tree : 
  Fs.File.t ->
  warnings:Odoc_model.Error.t list ->
  Odoc_model.Lang.SourceTree.t ->
  unit

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

val save_unit : 
  Fs.File.t ->
  warnings:Odoc_model.Error.t list ->
  unit_content ->
  unit

Save a module.

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.