Produce documentation for libraries installed with OPAM
OCaml JavaScript CSS Shell
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
scripts
src
static
.gitignore
.travis-ci.sh
.travis.yml
CHANGES
Makefile
README.md

README.md

opam-doc

Produce documentation for OPAM packages.

  • Depending on : opam, cow, compiler-libs.common, unix, ocamlfind
  • Requires: system compiler version >= 4.01

Usage

Compile the library and and install it by running:

make
make install

This will create a new OPAM switch called doc, using a system compiler switch with two small wrappers scripts which will call bin-doc after each invocation of the compiler.

Now you can generate the documentation for any package using:

opam doc PKG1 ... PKGn

The packages will be installed in the doc switch, and their documentation will be served on http://127.0.0.1:8000. You will need to either opam install async cohttp or have Python installed for the local webserver to work.

Set the OPAMDOC_BASE_URI environment variable to the URI that you wish to replace http://127.0.0.1:8000 by in the generated HTML.