package stog

  1. Overview
  2. Docs
type !'a level_fun =
  1. | Fun_stog of Stog_types.stog Xtmpl.env -> Stog_types.stog -> Stog_types.Doc_set.t -> Stog_types.stog
  2. | Fun_data of 'a Xtmpl.env -> (Stog_types.stog * 'a) -> Stog_types.Doc_set.t -> Stog_types.stog * 'a
  3. | Fun_stog_data of (Stog_types.stog * 'a) Xtmpl.env -> (Stog_types.stog * 'a) -> Stog_types.Doc_set.t -> Stog_types.stog * 'a
type !'a modul = {
  1. mod_data : 'a;
  2. mod_levels : 'a level_fun Stog_types.Int_map.t;
  3. mod_name : string;
}
module type Module = sig ... end
type stog_state = {
  1. st_stog : Stog_types.stog;
  2. st_modules : (module Module) list;
  3. st_docs : Stog_types.Doc_set.t;
}
val run : ?use_cache:bool -> stog_state -> stog_state
val generate : ?use_cache:bool -> ?only_docs:string list -> Stog_types.stog -> (module Module) list -> unit
val doc_dst : (string -> string -> string) -> ?encode:bool -> Stog_types.stog -> string -> Stog_types.doc -> string
val doc_dst_file : Stog_types.stog -> Stog_types.doc -> string
val env_of_defs : ?env:'a Xtmpl.env -> Stog_types.def list -> 'a Xtmpl.env
val env_of_used_mods : Stog_types.stog -> ?env:'a Xtmpl.env -> Stog_types.Str_set.t -> 'a Xtmpl.env
type !'a stog_doc_rules = Stog_types.stog -> Stog_types.doc_id -> (Xtmpl.name * 'a Xtmpl.callback) list
val get_in_env : 'a -> 'a Xtmpl.env -> Xmlm.name -> 'a * Xtmpl.tree list
val opt_in_env : 'a -> 'a Xtmpl.env -> Xmlm.name -> 'a * Xtmpl.tree list option
val get_in_args_or_env : 'a -> 'a Xtmpl.env -> Xtmpl.attributes -> Xmlm.name -> 'a * Xtmpl.tree list
val get_path : 'a -> 'a Xtmpl.env -> 'a * Stog_path.path
val get_path_in_args_or_env : 'a -> 'a Xtmpl.env -> Xtmpl.attributes -> 'a * Stog_path.path
val doc_env : 'a -> 'a Xtmpl.env -> Stog_types.stog -> Stog_types.doc -> 'a * 'a Xtmpl.env
val apply_stog_data_env_doc : (Stog_types.stog * 'a) -> (Stog_types.stog * 'a) Xtmpl.env -> Stog_types.doc_id -> Stog_types.stog * 'a
val apply_data_env_doc : (Stog_types.stog * 'a) -> 'a Xtmpl.env -> Stog_types.doc_id -> Stog_types.stog * 'a
val fun_apply_stog_doc_rules : Stog_types.stog stog_doc_rules -> 'a level_fun
val fun_apply_stog_data_doc_rules : (Stog_types.stog * 'a) stog_doc_rules -> 'a level_fun
val fun_apply_data_doc_rules : 'a stog_doc_rules -> 'a level_fun
val get_languages : 'a -> 'a Xtmpl.env -> 'a * string list
type module_fun = Stog_types.stog -> (module Module)
val modules : unit -> (string * module_fun) list
val register_module : string -> module_fun -> unit
val module_by_name : string -> module_fun option
OCaml

Innovation. Community. Security.