package odig

You can search for identifiers within the package.

in-package search v0.2.0

Lookup documentation of installed OCaml packages

Install

sha512=1658390e48b7698522bf539ee038476968c27b75cd90277dfeffb21258940fc2a1e24a12403aba24f7ad2ce33dc920d3149c7d3cfb74c5c3e961b1e96639e9de

Lookup package documentation directory.

type t

The type for documentation directory information.

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

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

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

changes_files i are the package's change log files.

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

license_files i are the package's licenses files.

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

odoc_pages i are the package's odoc pages

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

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

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

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

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

readme_files i are the package's readme files.

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

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

On This Page