Module Odig_odoc

module Odig_odoc: sig .. end

odoc API reference generation.

This mainly implements an odoc file resolution and generation request procedure specific to odig. Generic odoc driving bits are provided via B0_odoc.


val set_theme : Odig_support.Conf.t ->
Odig_support.Odoc_theme.t -> (unit, string) Stdlib.result

set_theme t sets theme odoc_theme in configuration conf.

val gen : Odig_support.Conf.t ->
force:bool ->
index_title:string option ->
index_intro:B0_std.Fpath.t option ->
pkg_deps:bool ->
tag_index:bool -> Odig_support.Pkg.t list -> (unit, string) Stdlib.result

gen c ~force ~index_intro ~pkg_deps ~tag_index pkgs generates API reference for packages pkgs.