package ocp-browser

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

Install

www.typerex.org Readme Changelog GPL-3.0-only License Edit opam file

Authors

  1. L
    Louis Gesbert
  2. Gabriel Radanne

Maintainers

  1. L
    louis.gesbert@ocamlpro.com

Sources

1.3.5.tar.gz
md5=0bc13dfb30c5dece280fd2496ca57cea
sha512=19f564a98cba92c26ebb32d46b7eb9eb60374977760c97b62c1ffa4f568d0a8e563df4a6bbc3ad7ca7760548c7c57465d1eb30ab5f3138c6fb1084d68c0cc0b0

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: 07 Aug 2023

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 >= "1.1.0"
  4. ocp-index = version
  5. dune >= "1.0"
  6. cppo build & >= "1.1.0"
  7. ocaml >= "4.08.0"

Dev Dependencies (1)

  1. odoc with-test

Used by

None

Conflicts

None