package odig

  1. Overview
  2. Docs

ocamldoc API documentation generation.

Ocamldoc

val htmldir : Conf.t -> Pkg.t option -> Fpath.t

htmldir c is is a function that returns the root or package ocamldoc HTML directory for c.

val compile : ocamldoc:Bos.Cmd.t -> force:bool -> Pkg.t -> (unit, [ `Msg of string ]) Pervasives.result

compile ~ocamldoc ~force p compiles the .ocodoc files from the .mli and .cmi files of package p.

val html : ocamldoc:Bos.Cmd.t -> force:bool -> Pkg.t -> (unit, [ `Msg of string ]) Pervasives.result

html ~ocamldoc ~force generates the html files from the .ocodoc files files of package p.

val htmldir_css_and_index : Conf.t -> (unit, [ `Msg of string ]) Pervasives.result

htmldir_css_and_index c generates the ocamldoc css and html package index for configuration c.

OCaml

Innovation. Community. Security.