I've just committed an addition to our CDBS class: automatic generation
of HTML documentation for libraries using ocamldoc. The semantics is as
follows.
- for each package listed in the Makefile variable
OCAML_OCAMLDOC_PACKAGES all *.ml and *.mli files installed somewhere
under /usr/lib/ocaml/x.y/ are passed to ocamldoc which is invoked to
generated HTML documentation
- additional flags to ocamldoc can be passed via OCAML_OCAMLDOC_FLAGS
which defaults to "-stars"
- the documentation is generated to
debian/PACKAGE/usr/share/doc/PACKAGE/html, and will be shipped by the
package in that very same directory
Question time now.
The default I've just committed is that no packages will use ocamldoc
per default. *But* I've added a new variable OCAML_DEV_PACKAGES which
contains all the packages named libXXX-ocaml-dev. The current approach
would be that every maintainer willing to use ocamldoc for her packages
should add to debian/rules the following line:
OCAML_OCAMLDOC_PACKAGES = $(OCAML_DEV_PACKAGES)
Since ideally I would like that all OCaml library package ship ocamldoc
generated documentation I'm inclined to change the cdbs default to the
line above. People who want to avoid that would free to add the
following line:
OCAML_OCAMLDOC_PACKAGES =
Comments? Which default do you prefer?
Cheers.
--
Stefano Zacchiroli -*- PhD in Computer Science ............... now what?
zack@{cs.unibo.it,debian.org,bononia.it} -%- http://www.bononia.it/zack/
(15:56:48) Zack: e la demo dema ? /\ All one has to do is hit the
(15:57:15) Bac: no, la demo scema \/ right keys at the right time
Attachment:
signature.asc
Description: Digital signature