package odoc-driver

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

OCaml compilation unit
Standalone pages units
Asset units
Packages

package odoc-driver

odoc-driver
- Odoc_driver_lib
  - Cmd_outputs
  - Common_args
  - Compile
  - Db
  - Global_config
  - Landing_pages
  - Library_names
  - Monorepo_style
  - Ocamlfind
    
    Db
  - Ocamlobjinfo
  - Odoc
    
    Id
  - Odoc_unit
    
    Pkg_args
  - Odoc_units_of
  - Opam
  - Packages
    
    Lib
  - Run
  - Sherlodoc
  - Stats
  - Util
    
    StringMap
    
    StringSet
  - Voodoo
  - Worker_pool

Legend:
Library
Module
Module type
Parameter
Class
Class type

OCaml compilation unit

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

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

OCaml Compilation unit

type modulety = {

m_name : string;
m_intf : intf;
m_impl : impl option;
m_hidden : bool;

}

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

Asset units

type asset = {

asset_path : Fpath.t;
asset_rel_path : Fpath.t;

}

val pp_asset : Format.formatter -> asset -> unit

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 ... end

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