package odig

You can search for identifiers within the package.

in-package search v0.2.0

Lookup documentation of installed OCaml packages

Install

sha512=b0150e45e0522ba1eb661414cd9640e96f25648cc2636b6faa994a1af91562e39b5959dfd5ddf24ec36abbe7190e5af3b83aa9299507bc4ebb55f5c7f17abba0

Lookup package documentation directory.

type t

The type for documentation directory information.

val dir : t -> B00_std.Fpath.t option

dir is the path to the documentation directory (if any).

val changes_files : t -> B00_std.Fpath.t list

changes_files i are the package's change log files.

val license_files : t -> B00_std.Fpath.t list

license_files i are the package's licenses files.

val odoc_pages : t -> B00_std.Fpath.t list

odoc_pages i are the package's odoc pages

val odoc_assets_dir : t -> B00_std.Fpath.t option

odoc_assets i is the package's odoc assets directory (if any).

val odoc_assets : t -> B00_std.Fpath.t list

odoc_assets i is the package's odoc assets directory contents.

val readme_files : t -> B00_std.Fpath.t list

readme_files i are the package's readme files.

val of_pkg : doc_dir:B00_std.Fpath.t -> Pkg.t -> t

query ~doc_dir pkg queries the documentation directory doc_dir for documentation about pkg.

On This Page