Awesome
odig — Lookup documentation of installed OCaml packages
%%VERSION%%
odig is a command line tool to lookup documentation of installed OCaml
packages. It shows package metadata, readmes, change logs, licenses,
cross-referenced odoc
API documentation and manuals.
odig is distributed under the ISC license. The theme fonts have their own licenses.
Homepage: https://erratique.ch/software/odig
Installation
odig can be installed with opam
:
opam install ocaml-manual odig
If you don't use opam
consult the opam
file for build
instructions.
Documentation
A few commands to get you started:
odig doc # Show API docs and manuals of installed packages
odig readme odig # Consult the readme of odig
odig changes odig # Consult the changelog of odig
odig browse issues odig # Browse odig's issues.
The manual and packaging conventions can be consulted online or
via odig doc odig
.
Sample odoc API documentation and manuals
A sample output of generated API documentation and manuals on a best-effort maximal set of packages of the OCaml opam repository is available here.
The Vg module and its sub-modules is a good example to look at, it has a good mix of documentation cases.
The different themes distributed with odig
can be seen on the sample
at the following addresses.
- https://b0-system.github.io/odig/doc/
- https://b0-system.github.io/odig/doc@odig.default/
- https://b0-system.github.io/odig/doc@odig.dark/
- https://b0-system.github.io/odig/doc@odig.light/
- https://b0-system.github.io/odig/doc@odig.gruvbox/
- https://b0-system.github.io/odig/doc@odig.gruvbox.dark/
- https://b0-system.github.io/odig/doc@odig.gruvbox.light/
- https://b0-system.github.io/odig/doc@odig.solarized/
- https://b0-system.github.io/odig/doc@odig.solarized.dark/
- https://b0-system.github.io/odig/doc@odig.solarized.light/
- https://b0-system.github.io/odig/doc@odoc.default/
Note that for technical reasons the OCaml manual under these addresses
is always themed according to odig.default
. This is not what happens
if you use odig
for yourself, the manual will render according to
your theme's color scheme.