From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.1.3 (2006-06-01) on yquem.inria.fr X-Spam-Level: * X-Spam-Status: No, score=1.1 required=5.0 tests=AWL,SPF_NEUTRAL autolearn=disabled version=3.1.3 Received: from mail4-relais-sop.national.inria.fr (mail4-relais-sop.national.inria.fr [192.134.164.105]) by yquem.inria.fr (Postfix) with ESMTP id CC82CBC69 for ; Wed, 21 Nov 2007 16:32:30 +0100 (CET) X-IronPort-AV: E=Sophos;i="4.21,447,1188770400"; d="scan'208";a="19539497" Received: from peray.inria.fr (HELO ausone.inria.fr) ([128.93.8.98]) by mail4-relais-sop.national.inria.fr with SMTP; 21 Nov 2007 16:32:30 +0100 Received: by ausone.inria.fr (sSMTP sendmail emulation); Wed, _d Nov 2007 16:31:43 +0100 From: "Nicolas Pouillard" Cc: caml-list Subject: Re: [Caml-list] ocamlbuild: generating documentation To: hmf References: <47444388.7020507@inescporto.pt> In-Reply-To: <47444388.7020507@inescporto.pt> Date: Wed, 21 Nov 2007 16:31:42 +0100 Message-Id: <1195656845-sup-3339@port-ext2.ensta.fr> User-Agent: Sup/0.2 Content-Type: text/plain; charset=UTF-8 X-Spam: no; 0.00; mli:01 ocaml-:01 mli:01 cvs:01 -pack:01 compile:01 caml-list:01 interfaces:01 modules:02 modules:02 module:03 misleading:03 hierarchy:03 aka:04 perhaps:05 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