package odig

All checked builds pass
  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.1.0.tbz
sha512=acabe752f5010900e9fe024321d6e34cc07f395ebd18f015a00b88c4c6482645b591a83a3f088f110adaf83e062551feb800a1dbca7646cce305eb3f542cfa41

Description

odig is a command line tool to lookup documentation of installed OCaml packages. It finds 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

Tags

build dev doc meta packaging org:erratique org:b0-system

Added to opam-repository:

README

odig — Lookup documentation of installed OCaml packages

odig is a command line tool to lookup documentation of installed OCaml packages. It finds 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.

Questions are welcome but better asked on the OCaml forum than on the issue tracker.

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.

Dependencies (7)

  1. b0 = "0.0.6"
  2. odoc >= "2.0.0"
  3. cmdliner >= "2.0.0"
  4. topkg build & >= "1.1.0"
  5. ocamlbuild build
  6. ocamlfind build
  7. ocaml >= "4.14.0"

Dev Dependencies

None

Optional Dependencies

None

Used by (6)

  1. ambient-context
  2. GT >= "0.5.3"
  3. nloge >= "0.0.2"
  4. ostap >= "0.6.1"
  5. sherlodoc
  6. zanuda >= "1.1.0"

Conflicts

None

Build status

Results of building odig with each compiler on check.ci.ocaml.org, run of against opam-repository 8a77e58. All results for this package.

Each result links to its build log. To keep crawlers from overloading the site, build logs require a GitHub sign-in (see ocurrent/opam-health-check). On your first log, GitHub asks you to “Authorize opam-health-check”, the OCurrent app that runs these checks; it sees only your public profile, not your repositories. The sign-in lasts 30 days.

Version OCaml 4.11 OCaml 4.14 OCaml 5.2 OCaml 5.4 OCaml 5.5
0.1.0 (this version) n/a good good good good
0.0.9 good good good good good
  • good Package successfully built
  • partial One of the dependencies failed to build
  • bad Package failed to build
  • n/a Package is not available in this environment
  • internal Internal failure