jon.recoil.org

Module Odoc_odoc.CompileSource

Sourcetype package_spec = {
  1. package : string;
  2. output : Fpath.t;
}
Sourcetype parent_spec = {
  1. parent : string option;
  2. children : string list;
  3. output : Fpath.t;
}
Sourcetype parent_id_spec = {
  1. parent_id : string;
  2. output_dir : string;
}
Sourcetype cli_spec =
  1. | CliNoParent of Fpath.t
  2. | CliPackage of Odoc_odoc.Compile.package_spec
  3. | CliParent of Odoc_odoc.Compile.parent_spec
  4. | CliParentId of Odoc_odoc.Compile.parent_id_spec
Sourceval name_of_output : prefix:string -> Odoc_odoc.Fs.File.t -> string

Compute the name of the page from the output file. Prefix is the prefix to remove from the filename.

Sourceval resolve_parent_page : Odoc_odoc.Resolver.t -> string -> (Odoc_model.Paths.Identifier.ContainerPage.t * Odoc_model.Lang.Page.child list, [> Odoc_utils.msg ]) Stdlib.result

Parse and resolve a parent reference. Returns the identifier of the parent and its children as a list of reference.

Sourceval path_of_id : string -> Odoc_model.Paths.Identifier.ContainerPage.t option -> Fpath.t
Sourceval compile : resolver:Odoc_odoc.Resolver.t -> hidden:bool -> cli_spec:Odoc_odoc.Compile.cli_spec -> warnings_options:Odoc_model.Error.warnings_options -> short_title:string option -> Fpath.t -> (unit, [> Odoc_utils.msg ]) Stdlib.result

Produces .odoc files out of .cm{i,t,ti} or .mld files.