package ocp-browser

  1. Overview
  2. Docs
Console browser for the documentation of installed OCaml libraries

Install

Dune Dependency

Authors

Maintainers

Sources

1.3.3.tar.gz
md5=738dd32765ce0b6b6423620cc62b7db9
sha512=6360240c951ac64baf9b3736c9a37c41a5ac8c5ddf52e723019fb5ef294e786e245712fd88f408bd8f6881d8741ab152872181062acd81443eec07d1d703e85a

Description

ocp-browser is a ncurses-like interface that allows to easily browse the interfaces and documentation of all installed OCaml modules.

Tags

org:ocamlpro org:typerex

Published: 26 Jan 2022

README

README.md

ocp-index is a light-weight tool and library providing easy access to the information contained in your OCaml cmi/cmt/cmti files. It can be used to provide features like library interface browsing, auto-completion, show-type and goto-source.

This source tree builds:

  • ocp-index.lib, the engine as a library

  • the ocp-index command-line tool

  • the ocp-grep command-line tool, that can search code for a given qualified OCaml ident (including uses after opens, etc.)

  • the ocp-browser tool, which is a browser for installed OCaml APIs on the terminal

The first tree are part of opam package ocp-index, and the latter is in its own ocp-browser package.

ocp-index is part of TypeRex, developed and maintained by OCamlPro. Documentation to install and use this tool is available on http://www.typerex.org/ocp-index.html

It is released under LGPL v3 with linking exception.

Dependencies (7)

  1. zed >= "2.0.0"
  2. lambda-term < "3.3.0"
  3. cmdliner
  4. ocp-index = version
  5. dune >= "1.0"
  6. cppo build & >= "1.1.0"
  7. ocaml >= "4.02.0"

Dev Dependencies (1)

  1. odoc with-test

Used by

None

Conflicts

None