package odig
Install
Dune Dependency
Authors
Maintainers
Sources
sha256=317bff8108f310ba14b435162f27921fb21f4f8a522121b1388b26b1515c496d
md5=cea6608b4d0a62df5c358d771fd1a148
doc/odig_support/Odig_support/Conf/index.html
Module Odig_support.Conf
Odig configuration.
Configuration
val v :
?cachedir:B0_std.Fpath.t ->
?libdir:B0_std.Fpath.t ->
?docdir:B0_std.Fpath.t ->
?sharedir:B0_std.Fpath.t ->
?odoc_theme:Odoc_theme.name ->
max_spawn:int option ->
unit ->
(t, string) Stdlib.resultv ~cachedir ~libdir ~docdir ~sharedir ~odoc_theme ~max_spawn () is a configuration with given attributes. If unspecified they are discovered.
val cachedir : t -> B0_std.Fpath.tcachedir c is c's cache directory.
val libdir : t -> B0_std.Fpath.tlibdir c is c's library directory.
val docdir : t -> B0_std.Fpath.tdocdir c is c's documentation directory.
sharedir c is c's share directory.
val htmldir : t -> B0_std.Fpath.thtmldir c is c's HTML directory, where the API docs are generated (derived from cachedir).
val odoc_theme : t -> stringodoc_theme c is c's odoc theme to use.
val pp : t B0_std.Fmt.tpp formats configurations.
Environment variables
cachedir_env is the environment variable that can be used to define the odig cache directory.
sharedir_env is the environment variable that can be used to define a sharedir.
odoc_theme_env is the environment variable that can be used to define the default odoc theme.
Properties
val memo : t -> (B00.Memo.t, string) Stdlib.resultmemo conf is a memoizer for configuration conf.
val memodir : t -> B0_std.Fpath.tmemodir c is c's memoizer cache directory.
val pkg_infos : t -> Pkg_info.t Pkg.Map.tpkg_infos conf are the package information of pkgs.