Am Montag, den 09.11.2009, 14:05 -0500 schrieb Ashish Agarwal: > I did install the godi-ocaml-manual, but this does not keep up with > API changes so it would be better to have ocamldoc generated > documentation.
As far as I know, the scripts used for running ocamldoc are not in the ocaml source tarball. > > Also this does not resolve the issue for other libraries. A quick look > through the god/doc directory and I find that none of the following > have API documentation installed: bin-prot, camomile, cryptgps, > json-wheel, ocamlscript, ounit, sexlib, type-conv. It seems so easy to > just run ocamldoc during installation, but I guess it is on the > package managers to do so. It's a bit more complicated. A number of these packages are camlp4 syntax extensions. For these, the API is usually not that interesting to know for the user, but the new syntax. (Unfortunately, nobody seems to know that one also can run ocamldoc on *.txt files to handle such non-API-related documentation.) Gerd > > > On Mon, Nov 9, 2009 at 1:27 PM, Gerd Stolpmann > <[email protected]> wrote: > > Am Montag, den 09.11.2009, 13:12 -0500 schrieb Ashish Agarwal: > > > most of the packages come with "integrated documentation" > > > > > > Does this include ocamldoc generated API documentation? It > would be > > great if this was available for all packages. For example, I > do not > > find documentation for the standard library. > > > The documentation is installed as it comes from upstream. So > for ocaml > there is a separate manual that covers the standard library, > and this is > available as godi-ocaml-manual. > > Gerd > > > > > > > > On Mon, Nov 9, 2009 at 12:53 PM, Gerd Stolpmann > > <[email protected]> wrote: > > > > Am Montag, den 09.11.2009, 17:20 +0100 schrieb > AUGER: > > > Hi all, > > > for instance, we have > > > *app > > > *conf > > > *godi > > > patckage types, but what about adding a > > > *doc > > > package type for ocamldoc generated documentation: > > > > > > compiling a documentation can take some time in > one hand > > > a lot of packages don't have their own > documentation > > (lablgtk2 for > > > instance), > > > > > > so installing or not a documentation is way too > general to > > be done in each > > > configure script, > > > and many package managers provide them separately, > so I > > think we should > > > offer doc packages > > > > > > There are a few manuals that are distributed > separately, but > > most of the > > packages come with "integrated documentation" (and > some, > > unfortunately, > > without, or there is only a web site). Either the > docs are > > just a bunch > > of already generated files that only need to be > copied to the > > right > > place, or they are generated on the fly with > ocamldoc (sure, > > it is > > sometimes time-consuming). > > > > I don't see why the addition of a new category makes > any of > > these things > > easier. Can you elaborate a bit more? > > > > Gerd > > -- > > > ------------------------------------------------------------ > > Gerd Stolpmann, Bad Nauheimer Str.3, 64289 > Darmstadt,Germany > > [email protected] > http://www.gerd-stolpmann.de > > Phone: +49-6151-153855 Fax: > +49-6151-997714 > > > ------------------------------------------------------------ > > > > > > _______________________________________________ > > Godi-list mailing list > > [email protected] > > > https://godirepo.camlcity.org/mailman/listinfo/godi-list > > > > > > > > _______________________________________________ > > Godi-list mailing list > > [email protected] > > https://godirepo.camlcity.org/mailman/listinfo/godi-list > > -- > > ------------------------------------------------------------ > Gerd Stolpmann, Bad Nauheimer Str.3, 64289 Darmstadt,Germany > [email protected] http://www.gerd-stolpmann.de > Phone: +49-6151-153855 Fax: +49-6151-997714 > ------------------------------------------------------------ > > > > > _______________________________________________ > Godi-list mailing list > [email protected] > https://godirepo.camlcity.org/mailman/listinfo/godi-list -- ------------------------------------------------------------ Gerd Stolpmann, Bad Nauheimer Str.3, 64289 Darmstadt,Germany [email protected] http://www.gerd-stolpmann.de Phone: +49-6151-153855 Fax: +49-6151-997714 ------------------------------------------------------------ _______________________________________________ Godi-list mailing list [email protected] https://godirepo.camlcity.org/mailman/listinfo/godi-list
