package ocp-browser

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

Install

Dune Dependency

www.typerex.org Readme Changelog LGPL-2.1-only WITH OCaml-LGPL-linking-exception License Edit opam file Versions (15)

Authors

  1. L
    Louis Gesbert
  2. Gabriel Radanne

Maintainers

  1. L
    louis.gesbert@ocamlpro.com

Sources

ocp-index-1.2.tbz
sha256=b93ed30df9ca321ff5758cdf43976034bcc5b3a23f83fcebbd524ea505e090d1
sha512=40d585edde42048d03b7672f29a0e4d0b92903d7b65f6d34f0c59d7ce29606bfc85a937b4967aea267eeb4f398990ec7ba8ec844858e433ce080a7f195a709b8

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: 28 Jan 2020

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.0.0"
  3. cmdliner
  4. ocp-index = version
  5. dune >= "1.0"
  6. ocp-pp build
  7. ocaml >= "4.02.0"

Dev Dependencies

None

Used by

None

Conflicts

None