From: Sylvain Le Gall <sylvain@le-gall.net>
To: "Daniel Bünzli" <daniel.buenzli@erratique.ch>
Cc: caml-list@inria.fr
Subject: Re: [Caml-list] Re: oasis packaging questions
Date: Fri, 9 Mar 2012 22:06:55 +0100 [thread overview]
Message-ID: <CAOCAUGMMriZ4c0Eyb+8SCm4QXbtGfPeBW+CPQRy8jO0Afydt0w@mail.gmail.com> (raw)
In-Reply-To: <8B4246A25F95441BB031B33E77CF68B7@erratique.ch>
Hi,
2012/3/9 Daniel Bünzli <daniel.buenzli@erratique.ch>:
>> E.g setting "Type:
>> ocamlbuild" + a couple of field to tell that your doc will be
>> extracted from some libraries/module and build using ocamldoc +
>> ocamlbuild:
>>
>> Document "api-ounit"
>> Title: API reference for OUnit
>> Type: ocamlbuild (0.2)
>> BuildTools+: ocamldoc
>> XOCamlbuildLibraries: oUnit
>> XOCamlbuildPath: src/
>
> In fact I may change my mind about that (since I already publish docs on the web). Two questions :
>
> 1) In the manual under the library section it's written :
>
> "Define an OCaml library. OCaml API is generated using `ocamldoc` applied to
> `Modules` with `BuildDepends` required flags."
>
> is that outdated info ? because in that case I don't even need to define a section like you do above.
No you are right, this is 'semi'-outdated info. It is only 'semi'
because this behavior is till handled by the OCamlbuild plugin, once
you have attached libraries to it.
A good example is
http://darcs.ocamlcore.org/cgi-bin/darcsweb.cgi?r=ounit/ounit;a=headblob;f=/_oasis
Basically, you attach library to this document using
'XOCamlbuildLibraries: oUnit' (you can attach more than if you want,
but I think it is no use for you).
>
> 2) In both cases how can I pass arguments to ocamldoc (I need to give it a -charset utf-8).
>
Good catch and the answer is "you can't". I think this is worth a
feature request.
Cheers
Sylvain
next prev parent reply other threads:[~2012-03-09 21:07 UTC|newest]
Thread overview: 28+ messages / expand[flat|nested] mbox.gz Atom feed top
2012-03-08 0:26 [Caml-list] " Daniel Bünzli
2012-03-08 8:31 ` [Caml-list] " Sylvain Le Gall
2012-03-08 15:36 ` Daniel Bünzli
2012-03-08 20:13 ` Sylvain Le Gall
2012-03-08 20:59 ` Daniel Bünzli
2012-03-08 21:27 ` Sylvain Le Gall
2012-03-08 22:39 ` Daniel Bünzli
2012-03-09 11:56 ` Gerd Stolpmann
2012-03-09 13:53 ` Daniel Bünzli
2012-03-09 18:42 ` Daniel Bünzli
2012-03-09 19:11 ` Sylvain Le Gall
2012-03-09 19:49 ` Daniel Bünzli
2012-03-09 20:35 ` Daniel Bünzli
2012-03-09 21:06 ` Sylvain Le Gall [this message]
2012-03-08 21:40 ` Adrien
2012-03-08 22:26 ` Sylvain Le Gall
2012-03-08 22:59 ` Daniel Bünzli
2012-03-09 12:22 ` Anil Madhavapeddy
2012-03-09 13:01 ` Wojciech Meyer
2012-03-12 0:38 ` Francois Berenger
2012-03-16 13:56 ` Damien Doligez
2012-03-08 16:09 ` [Caml-list] " Jérémie Dimino
2012-03-08 16:19 ` Gerd Stolpmann
2012-03-08 21:10 ` [Caml-list] " Sylvain Le Gall
2012-03-08 16:36 ` [Caml-list] " Daniel Bünzli
2012-03-08 16:58 ` Jérémie Dimino
2012-03-08 19:11 ` Daniel Bünzli
2012-03-09 6:40 ` Stéphane Glondu
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=CAOCAUGMMriZ4c0Eyb+8SCm4QXbtGfPeBW+CPQRy8jO0Afydt0w@mail.gmail.com \
--to=sylvain@le-gall.net \
--cc=caml-list@inria.fr \
--cc=daniel.buenzli@erratique.ch \
/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