package odig

  1. Overview
  2. Docs
Lookup documentation of installed OCaml packages

Install 

dune-project
 Dependency

erratique.ch Readme Changelog ISC; LicenseRef-ParaType-Free-Font-License; LicenseRef-DejaVu-fonts License Edit opam file Versions (2)

Authors

  1. T
    The odig programmers

Maintainers

  1. Daniel Bünzli

Sources

odig-0.1.0.tbz
sha512=acabe752f5010900e9fe024321d6e34cc07f395ebd18f015a00b88c4c6482645b591a83a3f088f110adaf83e062551feb800a1dbca7646cce305eb3f542cfa41

doc/odig_support/Odig_support/Conf/index.html

Module Odig_support.ConfSource

Odig configuration.

Configuration

Sourcetype t

The type for configuration.

Sourceval make : b0_cache_dir:B0_std.Fpath.t -> b0_log_file:B0_std.Fpath.t -> cache_dir:B0_std.Fpath.t -> cwd:B0_std.Fpath.t -> doc_dir:B0_std.Fpath.t -> html_dir:B0_std.Fpath.t -> jobs:int -> lib_dir:B0_std.Fpath.t -> odoc_theme:B0_odoc.Theme.name -> share_dir:B0_std.Fpath.t -> unit -> t

v consructs a configuration with given attributes. See the corresponding accessors for details.

Sourceval b0_cache_dir : t -> B0_std.Fpath.t

b0_cache_dir c is c's b0 cache directory.

Sourceval b0_log_file : t -> B0_std.Fpath.t

b0_log_file c is c's b0 log file.

Sourceval cache_dir : t -> B0_std.Fpath.t

cache_dir c is c's cache directory.

Sourceval cwd : t -> B0_std.Fpath.t

cwd c is c's current working directory.

Sourceval doc_dir : t -> B0_std.Fpath.t

doc_dir c is c's documentation directory.

Sourceval lib_dir : t -> B0_std.Fpath.t

lib_dir c is c's library directory.

Sourceval 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).

Sourceval odoc_theme : t -> B0_odoc.Theme.name

odoc_theme c is c's odoc theme to use.

Sourceval jobs : t -> int

jobs c is the maximum number of spawns.

Sourceval memo : t -> (B0_memo.t, string) Stdlib.result

memo conf is a memoizer for configuration conf.

Sourceval pkgs : t -> Pkg.t list

pkgs conf are the packages of configuration conf.

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

pkg_infos conf are the package information of pkgs.

Sourceval share_dir : t -> B0_std.Fpath.t

share_dir c is c's share directory.

Sourceval pp : t B0_std.Fmt.t

pp formats configurations.

Setup

Sourceval setup_with_cli : 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

setup_with_cli determines and setups a configuration with the given values. These are expected to have been determined by environment variables and command line arguments.