package odig

You can search for identifiers within the package.

in-package search v0.2.0

Lookup documentation of installed OCaml packages

Install

Dune Dependency

erratique.ch Readme Changelog ISC; LicenseRef-ParaType-Free-Font-License; LicenseRef-DejaVu-fonts License Edit opam file Versions (7)

Authors

T

The odig programmers

Maintainers

Daniel Bünzli

Sources

odig-0.0.7.tbz

sha512=1398656a8719a37db3f47083a08ab7124ec51bd1df5fe0e4b65410088267f21eccb096ea7494237c411a68e17c44c27d3789f1c8835dcb533c921391425f4def

doc/odig.support/Odig_support/Pkg_info/index.html

Module `Odig_support.Pkg_info`

Gather package information

Gathers Doc_cobj, Opam and Docdir information about a package.

Package info

type t

The type for package information.

val doc_cobjs : t -> Doc_cobj.t list

doc_cobjs i are the documentation compilation objects of i.

val doc_dir : t -> Doc_dir.t

doc_dir i is the doc dir information of i.

val opam : t -> Opam.t

opam i is the opam information of i.

Uniform field access

Access information as list of strings.

type field = [

| `Authors
| `Changes_files
| `Depends
| `Doc_cobjs
| `Homepage
| `Issues
| `License
| `License_files
| `Maintainers
| `Odoc_assets
| `Odoc_pages
| `Online_doc
| `Readme_files
| `Repo
| `Synopsis
| `Tags
| `Version

]

The type for fields.

val field_names : (string * field) list

field_names associated a string name to each field.

val get : field -> t -> string list

get field i is the field field of i as a list of strings.

val pp : t B00_std.Fmt.t

pp formats all package information fields in alphabetic order.

Queries

val query : doc_dir:B00_std.Fpath.t -> Pkg.t list -> (Pkg.t * t) list

query ~doc_dir pkgs combines the result of Doc_cobj.of_pkg, Queries and Doc_dir.of_pkg.

On This Page

Package info
Uniform field access
Queries