package forester

  1. Overview
  2. Docs
type config = {
  1. env : Eio_unix.Stdenv.base;
  2. assets_dirs : Eio.Fs.dir_ty Eio.Path.t list;
  3. theme_dir : Eio.Fs.dir_ty Eio.Path.t;
  4. root : Core.addr option;
  5. base_url : string option;
  6. stylesheet : string;
  7. ignore_tex_cache : bool;
  8. no_assets : bool;
  9. no_theme : bool;
  10. max_fibers : int;
}
type raw_forest = Core.Code.tree list
type forest = {
  1. trees : Core.Sem.tree Forester.Analysis.Map.t;
  2. analysis : Analysis.analysis Stdlib.Lazy.t;
}
val plant_forest : raw_forest -> forest
val render_trees : cfg:config -> forest:forest -> unit
val create_tree : cfg:config -> addrs:Core.addr Stdlib.Seq.t -> dest:Eio.Fs.dir_ty Eio.Path.t -> prefix:string -> template:string option -> mode:[ `Sequential | `Random ] -> Core.addr
val complete : forest:forest -> string -> (Core.addr * string) Stdlib.Seq.t
val prefixes : addrs:Core.addr Stdlib.Seq.t -> string list
val taxa : forest:forest -> (Core.addr * string) Stdlib.Seq.t
val tags : forest:forest -> (Core.addr * string list) Stdlib.Seq.t
val run_renderer : cfg:config -> forest -> (unit -> 'a) -> 'a
val render_json : cwd:[> Eio__.Fs.dir_ty ] Eio.Path.t -> Core.Sem.tree Forester.Analysis.Map.t -> unit
OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct