ocamlbuild -pack and ocamldoc

ocamlbuild -pack and ocamldoc

[Benedikt Grundmann]

Hi list (and Nicolas in particular),

I have a rather big project consisting of several parts.  I currently
build everything
using one central myocamlbuild.ml file, one pN.mlpack file for each
part, a _tags file in each part that  adds the for-pack(pN) option and
sometimes the necessary camlp4o, use_<syntaxext> tag.
The parts are not independent of each other.

I want to add a (ocamldoc) reference to my project.  Ideally one for
the complete project, where each part is correctly packed and there is
one central index.html file.  Originally I had a file pN/pNdoc.odocl
for each part pN and called ocamlbuild pN/pNdoc.docdir/index.html,
which worked until I added the -pack option.  Now depending on the
options I set, I either get an error message by ocamlbuild stating
that it does not know how to build pN/foo.odoc or an error message by
ocamldoc stating that it does not know how to find certain files.

What is the proper way to use ocamldoc together with ocamlbuild in
such a scenario?

Thanks in advance,

Bene

-- 
Calvin: Life is full of surprises, but never when you need one.



(From Calvin & Hobbes)

Re: [Caml-list] ocamlbuild -pack and ocamldoc

[Nicolas Pouillard]

Excerpts from Benedikt Grundmann's message of Wed Nov 28 12:11:02 +0100 2007:
> Hi list (and Nicolas in particular),
Hi,

> I have a rather big project consisting of several parts.  I currently
> build everything
> using one central myocamlbuild.ml file, one pN.mlpack file for each
> part, a _tags file in each part that  adds the for-pack(pN) option and
> sometimes the necessary camlp4o, use_<syntaxext> tag.
> The parts are not independent of each other.
Sounds good.

> I want to add a (ocamldoc) reference to my project.  Ideally one for
> the complete project, where each part is correctly packed and there is
> one central index.html file.  Originally I had a file pN/pNdoc.odocl
> for each part pN and called ocamlbuild pN/pNdoc.docdir/index.html,
> which worked until I added the -pack option.  Now depending on the
> options I set, I either get an error message by ocamlbuild stating
> that it does not know how to build pN/foo.odoc or an error message by
> ocamldoc stating that it does not know how to find certain files.
> 
> What is the proper way to use ocamldoc together with ocamlbuild in
> such a scenario?
There  is  no  proper  way,  but a way that works quite well. You can define a
rule  that  syntacly  pack all your interfaces into a big mli. Then give it to
ocamldoc.

-- 
Nicolas Pouillard aka Ertai

Re: [Caml-list] ocamlbuild -pack and ocamldoc

[Ashish Agarwal]

[-- Attachment #1: Type: text/plain, Size: 180 bytes --]

> You can define a
> rule that syntacly pack all your interfaces into a big mli. Then give it
to
> ocamldoc.

Is there a built-in way to do this? I was just writing my own script.

[-- Attachment #2: Type: text/html, Size: 212 bytes --]

Re: [Caml-list] ocamlbuild -pack and ocamldoc

[Nicolas Pouillard]

Excerpts from Ashish Agarwal's message of Wed Nov 28 15:22:14 +0100 2007:
> > You can define a
> > rule that syntacly pack all your interfaces into a big mli. Then give it
> to
> > ocamldoc.
> 
> Is there a built-in way to do this? I was just writing my own script.

Not yet.
-- 
Nicolas Pouillard aka Ertai