package odig

  1. Overview
  2. Docs
Lookup documentation of installed OCaml packages

Install 

dune-project
 Dependency

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

Authors

  1. T
    The odig programmers

Maintainers

  1. Daniel Bünzli

Sources

odig-0.0.9.tbz
sha512=1658390e48b7698522bf539ee038476968c27b75cd90277dfeffb21258940fc2a1e24a12403aba24f7ad2ce33dc920d3149c7d3cfb74c5c3e961b1e96639e9de

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

Module Odig_support.Pkg_infoSource

Gather package information

Gathers Doc_cobj, Opam and Docdir information about a package.

Package info

Sourcetype t

The type for package information.

Sourceval doc_cobjs : t -> Doc_cobj.t list

doc_cobjs i are the documentation compilation objects of i.

Sourceval doc_dir : t -> Doc_dir.t

doc_dir i is the doc dir information of i.

Sourceval opam : t -> Opam.t

opam i is the opam information of i.

Uniform field access

Access information as list of strings.

Sourcetype field = [
  1. | `Authors
  2. | `Changes_files
  3. | `Depends
  4. | `Doc_cobjs
  5. | `Homepage
  6. | `Issues
  7. | `License
  8. | `License_files
  9. | `Maintainers
  10. | `Odoc_assets
  11. | `Odoc_pages
  12. | `Online_doc
  13. | `Readme_files
  14. | `Repo
  15. | `Synopsis
  16. | `Tags
  17. | `Version
]

The type for fields.

Sourceval field_names : (string * field) list

field_names associated a string name to each field.

Sourceval get : field -> t -> string list

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

pp formats all package information fields in alphabetic order.

Queries

Sourceval query : doc_dir:B0_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.