package stog

You can search for identifiers within the package.

in-package search v0.2.0

package stog

stog
- Stog
  - Blocks
    
    Smap
  - Config
  - Cut
  - Date
  - Deps
  - Doclist
  - Dyn
  - Engine
    
    Module
  - Error
  - Exec
  - Filter
  - Filter_lexer
  - Filter_parser
  - Filter_types
  - Find
  - Graph
    
    GMap
    
    Make
    
    Edge
    
    M
    
    Make_with_map
    
    Edge
    
    P
    
    S
  - Highlight
  - Html
  - Html5
  - Info
  - Init
  - Install
    
    Sites
  - Intl
  - Io
  - Latex
  - Log
  - Ocaml
  - Of_latex
    
    SMap
  - Path
    
    Map
    
    Set
  - Plug
  - Server_mode
  - Svg
  - Tags
  - Tmap
    
    S
  - Tmpl
  - Trie
    
    Make
    
    P
    
    S
  - Types
    
    Depset
    
    Doc_set
    
    Graph
    
    Int_map
    
    Int_set
    
    Path_trie
    
    Str_map
    
    Str_set
  - Url
  - Version
stog.base
- Stog_base
  - Misc
  - Ocaml_types
stog.main
- Stog_main
stog.ocaml_session_main
- Stog_ocaml_session_main

Legend:
Library
Module
Module type
Parameter
Class
Class type

Reading stog config.

val debug : bool ref

type module_levels = {

module_name : string;
levels : (string * int list) list;

}

type t = {

ignored : string list;
documents : string list;
not_documents : string list;
follow_symlinks : bool;
levels : module_levels 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.