Mining OCaml package installs
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
doc
etc
pkg Drop mtime package dependency. Jun 14, 2018
src-bin Change copyrights to contributor based copyrights. Jun 14, 2018
src Change copyrights to contributor based copyrights. Jun 14, 2018
.gitignore First commit. Sep 23, 2016
.merlin Drop mtime package dependency. Jun 14, 2018
.ocp-indent First commit. Sep 23, 2016
CHANGES.md Drop mtime package dependency. Jun 14, 2018
LICENSE.md Change copyrights to contributor based copyrights. Jun 14, 2018
README.md README tweaks. Jun 14, 2018
SEL.md s/OPAM/opam/g Feb 6, 2017
_tags Drop mtime package dependency. Jun 14, 2018
opam Change copyrights to contributor based copyrights. Jun 14, 2018

README.md

odig — Mine installed OCaml packages

%%VERSION%%

odig is a library and command line tool to mine installed OCaml packages. It supports package lookups for distribution documentation, metadata and generates cross-referenced API documentation.

odig is distributed under the ISC license.

Homepage: http://erratique.ch/software/odig

Installation

odig can be installed with opam:

opam install odoc ocaml-manual odig

If you don't use opam consult the opam file for build instructions.

Usage

odig doc
odig changes PKG
odig readme PKG

Documentation & tutorial

The documentation, tutorial and API reference is generated from the source interfaces. It can be consulted online or via odig doc odig.