Mailing list for all users of the OCaml language and system.
 help / color / mirror / Atom feed
From: "Nicolas Pouillard" <nicolas.pouillard@gmail.com>
To: hmf <hmf@inescporto.pt>
Cc: caml-list <caml-list@yquem.inria.fr>
Subject: Re: [Caml-list] ocamlbuild: generating documentation
Date: Wed, 21 Nov 2007 16:31:42 +0100	[thread overview]
Message-ID: <1195656845-sup-3339@port-ext2.ensta.fr> (raw)
In-Reply-To: <47444388.7020507@inescporto.pt>

Excerpts from hmf's message of Wed Nov 21 15:41:12 +0100 2007:
> Hello,
Hello,

> I am attempting to use the document generation option provided by
> ocamlbuild. The manual states that ocamlbuild will "collect all the
> documentation for the interfaces (which will be built if necessary").
> 
> Questions:
> 1. How can I change this so that both *.ml and *.mli file are be used?

If  I well remember in OCaml-3.10.0 only mli files are took in account. In the
CVS version ml files are used when no mli can be built.

> 2. Must I compile the files prior to invoking "ocamlbuild
> all.docdir/index.html" at any point?

No it must works nicely without any pre-compilation.

> On a different issue, the manual refers to "packing subdirectories
> into modules"...
> 
> 1. Are we talking about indicating a path here, for example:
> 
> cat all.odocl
> src/mod/Mod
> 
> So that Mod is documented?

No it's not related.

Packing  subdirectories  is  about  using  -pack  to nest modules into one big
module.  The  "subdirectories"  here  is perhaps misleading but that's because
most  of  the  time  packages are used to reflect the directory hierarchy into
modules.

-- 
Nicolas Pouillard aka Ertai


  reply	other threads:[~2007-11-21 15:32 UTC|newest]

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2007-11-21 14:41 Hugo Ferreira
2007-11-21 15:31 ` Nicolas Pouillard [this message]
2007-11-21 16:00   ` [Caml-list] " Hugo Ferreira
2007-11-23 14:43     ` Nicolas Pouillard
2007-11-23 15:29       ` Hugo Ferreira
2007-11-24 10:49         ` Nicolas Pouillard

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=1195656845-sup-3339@port-ext2.ensta.fr \
    --to=nicolas.pouillard@gmail.com \
    --cc=caml-list@yquem.inria.fr \
    --cc=hmf@inescporto.pt \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox