package odoc

  1. Overview
  2. Docs
package odoc
Legend:
Library
Module
Module type
Parameter
Class
Class type
type package_spec = {
  1. package : string;
  2. output : Fpath.t;
}
type parent_spec = {
  1. parent : string option;
  2. children : string list;
  3. output : Fpath.t;
}
type parent_id_spec = {
  1. parent_id : string;
  2. output_dir : string;
}
type cli_spec =
  1. | CliNoParent of Fpath.t
  2. | CliPackage of package_spec
  3. | CliParent of parent_spec
  4. | CliParentId of parent_id_spec
val name_of_output : prefix:string -> Fs.File.t -> string

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

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

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

val mk_id : string -> Odoc_model.Paths.Identifier.ContainerPage.t option
val path_of_id : string -> Odoc_model.Paths.Identifier.ContainerPage.t option -> Fpath.t
val compile : resolver:Resolver.t -> hidden:bool -> cli_spec:cli_spec -> warnings_options:Odoc_model.Error.warnings_options -> short_title:string option -> Fpath.t -> (unit, [> Or_error.msg ]) Or_error.result

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

OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct