From: John Max Skaller <skaller@ozemail.com.au>
To: Markus Mottl <mottl@miss.wu-wien.ac.at>
Cc: Fabrice Le Fessant <fabrice.le_fessant@inria.fr>, caml-list@inria.fr
Subject: Re: [Caml-list] CDK binary release
Date: Thu, 10 May 2001 03:58:02 +1000 [thread overview]
Message-ID: <3AF9852A.F2B18679@ozemail.com.au> (raw)
In-Reply-To: <20010509125858.B28402@miss.wu-wien.ac.at>
Markus Mottl wrote:
> I have just taken a look at the way documentation is handled. It would
> be fine if there were some kind of standard way to prepare documentation
> for OCaml-sources in general. It's otherwise a tremendous effort to
> maintain various formats (and who likes writing documentation anyway? ;)
But the CDK generates documentation is a way that clearly
defines such a 'standard'. So what's needed is a description
of this for people preparing packages for inclusion in CDK.
I'd also suggest that every package be allowed a
'native html documentation directory'. If present,
a link in the generated documentation to it would allow the
reader to go the suppliers original html documentation.
[For example, if there is a 'doc' directory
in the package, the CDK summary could include a link
to 'doc/index.html']
--
John (Max) Skaller, mailto:skaller@maxtal.com.au
10/1 Toxteth Rd Glebe NSW 2037 Australia voice: 61-2-9660-0850
checkout Vyper http://Vyper.sourceforge.net
download Interscript http://Interscript.sourceforge.net
-------------------
To unsubscribe, mail caml-list-request@inria.fr. Archives: http://caml.inria.fr
next prev parent reply other threads:[~2001-05-13 20:22 UTC|newest]
Thread overview: 31+ messages / expand[flat|nested] mbox.gz Atom feed top
2001-05-07 9:06 Fabrice Le Fessant
2001-05-07 16:09 ` Miles Egan
2001-05-07 17:17 ` John Max Skaller
2001-05-09 10:58 ` Markus Mottl
2001-05-09 12:01 ` [Caml-list] About documentation tools David Mentre
2001-05-09 13:18 ` [Caml-list] " Markus Mottl
2001-05-09 18:17 ` John Max Skaller
2001-05-09 17:58 ` John Max Skaller [this message]
2001-05-09 22:40 ` [Caml-list] CDK binary release Markus Mottl
2001-05-09 23:19 ` John Max Skaller
2001-05-10 9:19 ` Fabrice Le Fessant
2001-05-10 10:34 ` [Caml-list] CDK Documentation format Dave Mason
2001-05-13 21:26 ` Stefan Monnier
2001-05-10 11:16 ` [Caml-list] CDK binary release Sven LUTHER
2001-05-10 13:18 ` Markus Mottl
2001-05-10 15:42 ` Jean-Christophe Filliatre
2001-05-10 16:08 ` Thorsten Ohl
2001-05-10 22:53 ` Markus Mottl
2001-05-10 20:36 ` John Max Skaller
2001-05-10 14:01 ` David Mentre
2001-05-10 15:09 ` Patrick M Doane
2001-05-10 15:06 ` Patrick M Doane
2001-05-11 11:58 ` Fabrice Le Fessant
2001-05-11 15:31 ` John Max Skaller
2001-05-11 15:44 ` Fabrice Le Fessant
2001-05-13 21:33 ` Stefan Monnier
2001-05-11 17:30 ` Patrick M Doane
2001-05-12 7:46 ` Fabrice Le Fessant
2001-05-11 23:24 ` Brian Rogoff
2001-05-10 15:49 ` John Max Skaller
2001-05-14 8:21 ` Olivier Andrieu
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=3AF9852A.F2B18679@ozemail.com.au \
--to=skaller@ozemail.com.au \
--cc=caml-list@inria.fr \
--cc=fabrice.le_fessant@inria.fr \
--cc=mottl@miss.wu-wien.ac.at \
/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;
as well as URLs for NNTP newsgroup(s).