Module Odig.Odoc

module Odoc: sig .. end
odoc API documentation generation.


Odoc


val htmldir : Odig.Conf.t -> Odig.Pkg.t option -> Fpath.t
htmldir c is is a function that returns the root or package odoc HTML directory for c.
val compile : odoc:Bos.Cmd.t ->
force:bool -> Odig.Pkg.t -> (unit, [ `Msg of string ]) Pervasives.result
compile ~odoc ~force p compiles the .odoc files from the .cmti files of package p.
val html : odoc:Bos.Cmd.t ->
force:bool -> Odig.Pkg.t -> (unit, [ `Msg of string ]) Pervasives.result
html ~odoc ~force p generates the html files from the .odoc 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 odoc css and html package index for configuration c.