Stog library reference documentation : Stog_config

Module Stog_config

module Stog_config: sig .. end
Reading stog config.

type t = {
   ignored : string list; (*list of regexps of filenames to ignore*)
   documents : string list; (*list of regexps for document files*)
   not_documents : string list; (*list of regexps for file matching documents rules but not being documents*)
   follow_symlinks : bool;
   levels : (string * (string * int list) list) list;
}
Contents of .stog/config file.
val config_dir : string -> string
config_dir dir returns the stog configuration directory in the given directory.
val config_file : string -> string
config_file dir returns the stog config file for a given project directory, that is Filename.concat (config_dir dir) "config".
val tmpl_dir : string -> string
tmpl_dir dir returns the directory containing templates, from a stog project directory.
val cache_dir : string -> string
cache_dir dir returns the cache directory, from a stog project directory.
val modules_dir : string -> string
modules_dir dir returns the modules directory, from a stog project directory.
val read_config : string -> t
read_config file returns the configuration stored in the given stog configuration file. If the file does not exists, it is created. The file is also written back, so that new fields automatically appear in the file.