Produce documentation for libraries installed with OPAM
OCaml
Switch branches/tags
Nothing to show
Pull request Compare This branch is 2 commits ahead, 123 commits behind ocaml-attic:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
cmt_folder-4.01.0dev+trunk
.gitignore
Makefile
README.md
cmd_format.ml
docjson.ml
docjson.mli
doctree.ml
doctree.mli
driver.ml
generate.ml
gentyp.ml
gentyp.mli
html_utils.ml
html_utils.mli
index.ml
index.mli
info.ml
info.mli
opam_doc_config.ml

README.md

opam-doc

Produce documentation for libraries installed with OPAM

Depending on : cow, compiler-libs.common, unix

Requires compiler version >= 4.01

====

Usage :

  • run bin-doc on your package's ml/mli files to get the cmd[i]s
  • compile your package source files adding the '-bin-annot' option in order to generate the typed tree files (cmt[i])
  • cd to a directory that will contain all the opam-doc generated documentation (e.g ~/.opam/4.X.X/doc)
  • run : opam-doc --package 'package_name' *.cmt* *.cmd*