Version française
Home     About     Download     Resources     Contact us    

This site is updated infrequently. For up-to-date information, please visit the new OCaml website at

Browse thread
Trouble with Ocamldoc + Ocamlbuild
[ Home ] [ Index: by date | by threads ]
[ Search: ]

[ Message by date: previous | next ] [ Message in thread: previous | next ] [ Thread: previous | next ]
Date: 2009-02-27 (19:57)
From: Dario Teixeira <darioteixeira@y...>
Subject: Trouble with Ocamldoc + Ocamlbuild


I'm having some trouble getting Ocamlbuild to produce API documentation via
Ocamldoc in a project that uses packed modules.  The project has two main
directories, modA and modB, each contanining a couple of modules, as follows:

  |- Foo
  |- Bar

  |- Glu
  |- Bah

I placed the modA.mlpack and modB.mlpack files at the top-level, listing the
modules in the respective directories.  The main target itself is to build
the library mylib.cma, containing the packed modules modA.cmo and modB.cmo.
Therefore, also at the top level directory is the file mylib.mllib, whose
contents are "modA" and "modB" in separate lines.

Now, building the library with "ocamlbuild mylib.cma" works fine.  But how
can I tell Ocamlbuild to build the API doc with Ocamldoc?  I reckon I have
to create a mylib.odocl file at the top-level, but what should its contents
be? I have tried "modA" and "modB", but it doesn't work.  Neither does a
fully qualified specification, such as "modA.Foo", etc.  Any thoughts?

Thanks in advance!
Best regards,
Dario Teixeira

P.S. The caml-list seems to be cloning posts today.  Sorry if you get this
     message multiple times.