Something went wrong. Try again.
Odoc docs forked from jon.recoil.org/odd
Something went wrong. Try again.
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102(** {1 OCaml compilation unit} *)
(** {2 Interface part} *)
type dep = string * Digest.t
type intf = { mif_hash : string; mif_path : Fpath.t; mif_deps : dep list }
val pp_intf : Format.formatter -> intf -> unit
(** {2 Implementation part} *)
type src_info = { src_path : Fpath.t }
type impl = { mip_path : Fpath.t; mip_src_info : src_info option; mip_deps : dep list;}
val pp_impl : Format.formatter -> impl -> unit
(** {2 OCaml Compilation unit} *)
type modulety = { m_name : string; m_intf : intf; m_impl : impl option; m_hidden : bool;}
(** {1 Standalone pages units} *)
type mld = { mld_path : Fpath.t; mld_rel_path : Fpath.t }
type md = { md_path : Fpath.t; md_rel_path : Fpath.t }
val pp_mld : Format.formatter -> mld -> unit
val pp_md : Format.formatter -> md -> unit
(** {1 Asset units} *)
type asset = { asset_path : Fpath.t; asset_rel_path : Fpath.t }
val pp_asset : Format.formatter -> asset -> unit
(** {1 Packages} *)
(** Compilation units are associated to libraries, while documentation are associated to package *)
type libty = { lib_name : string; dir : Fpath.t; archive_name : string option; lib_deps : Util.StringSet.t; modules : modulety list; id_override : string option;}
module Lib : sig val v : libname_of_archive:string Fpath.Map.t -> pkg_name:string -> dir:Fpath.t -> cmtidir:Fpath.t option -> all_lib_deps:Util.StringSet.t Util.StringMap.t -> cmi_only_libs:(Fpath.t * string) list -> id_override:string option -> libty list
val pp : Format.formatter -> libty -> unitend
type t = { name : string; version : string; libraries : libty list; mlds : mld list; assets : asset list; selected : bool; remaps : (string * string) list; other_docs : md list; pkg_dir : Fpath.t; doc_dir : Fpath.t; config : Global_config.t;}
val pp : Format.formatter -> t -> unit
val fix_missing_deps : t list -> t list
val mk_mlds : Opam.doc_file list -> mld list * asset list * md list
val of_libs : packages_dir:Fpath.t option -> Util.StringSet.t -> t list(** Turns a set of libraries into a map from package name to package *)
val of_packages : packages_dir:Fpath.t option -> string list -> t list
val remap_virtual : t list -> t list