package odig

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Configuration
Environment variables
Properties

package odig

Legend:
Library
Module
Module type
Parameter
Class
Class type

Odig configuration.

Configuration

type t

The type for 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) result

v ~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.t

cachedir c is c's cache directory.

val libdir : t -> B0_std.Fpath.t

libdir c is c's library directory.

val docdir : t -> B0_std.Fpath.t

docdir c is c's documentation directory.

val sharedir : t -> B0_std.Fpath.t

sharedir c is c's share directory.

val htmldir : t -> B0_std.Fpath.t

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

val odoc_theme : t -> string

odoc_theme c is c's odoc theme to use.

val pp : t B0_std.Fmt.t

pp formats configurations.

Environment variables

val cachedir_env : string

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

val libdir_env : string

libdir_env is the environment variable that can be used to define a libdir.

val docdir_env : string

docdir_env is the environment variable that can be used to define a docdir.

val sharedir_env : string

sharedir_env is the environment variable that can be used to define a sharedir.

val odoc_theme_env : string

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) result

memo conf is a memoizer for configuration conf.

val memodir : t -> B0_std.Fpath.t

memodir c is c's memoizer cache directory.

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.