Module Odig.Ocamldoc

module Ocamldoc: sig .. end
ocamldoc API documentation generation.


Ocamldoc


val htmldir : Odig.Conf.t -> Odig.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 -> Odig.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 -> Odig.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 : Odig.Conf.t -> (unit, [ `Msg of string ]) Pervasives.result
htmldir_css_and_index c generates the ocamldoc css and html package index for configuration c.