Module Odig_support.Conf

Odig configuration.

Configuration

type t

The type for configuration.

val v : b0_cache_dir:B0_std.Fpath.t option -> b0_log_file:B0_std.Fpath.t option -> cache_dir:B0_std.Fpath.t option -> doc_dir:B0_std.Fpath.t option -> jobs:int option -> lib_dir:B0_std.Fpath.t option -> odoc_theme:B0_odoc.Theme.name option -> share_dir:B0_std.Fpath.t option -> unit -> (t, string) Stdlib.result

v consructs a configuration with given attributes. If unspecified they are discovered in various ways.

val b0_cache_dir : t -> B0_std.Fpath.t

b0_cache_dir c is c's b0 cache directory.

val b0_log_file : t -> B0_std.Fpath.t

b0_log_file c is c's b0 log file.

val cache_dir : t -> B0_std.Fpath.t

cache_dir c is c's cache directory.

val doc_dir : t -> B0_std.Fpath.t

doc_dir c is c's documentation directory.

val lib_dir : t -> B0_std.Fpath.t

lib_dir c is c's library directory.

val html_dir : t -> B0_std.Fpath.t

html_dir c is c's HTML directory, where the API docs are generated (derived from cache_dir).

val odoc_theme : t -> string

odoc_theme c is c's odoc theme to use.

val jobs : t -> int

jobs c is the maximum number of spawns.

val memo : t -> (B00.Memo.t, string) Stdlib.result

memo conf is a memoizer for configuration conf.

val pkgs : t -> Pkg.t list

pkgs conf are the packages of configuration conf.

val pkg_infos : t -> Pkg_info.t Pkg.Map.t

pkg_infos conf are the package information of pkgs.

val share_dir : t -> B0_std.Fpath.t

share_dir c is c's share directory.

val pp : t B0_std.Fmt.t

pp formats configurations.

Environment variables

val cache_dir_env : string

cache_dir_env is the environment variable that can be used to define the odig cache directory.

val lib_dir_env : string

lib_dir_env is the environment variable that can be used to define a lib dir.

val doc_dir_env : string

doc_dir_env is the environment variable that can be used to define a doc dir.

val share_dir_env : string

share_dir_env is the environment variable that can be used to define a share dir.

val odoc_theme_env : string

odoc_theme_env is the environment variable that can be used to define the default odoc theme.