Original bug ID: 7362
Reporter: @dbuenzli
Status: closed (set by @damiendoligez on 2016-10-25T15:03:26Z)
Resolution: fixed
Priority: normal
Severity: minor
Version: 4.03.0
Target version: 4.04.0 +dev / +beta1 / +beta2
Fixed in version: 4.04.0 +dev / +beta1 / +beta2
Category: documentation
Monitored by: @gasche @hcarty @dbuenzli

Bug description

In the opkg project we automatically generate cross-linked API documentation for installed packages. The way packages are supposed to indicate what should be present in the generated API documentation is by installing mli and cmi (for ocamldoc generation) and cmti (for odoc generation) files for the modules that constitutes your API and you would like to see documented (more control through the package meta-data file may be provided in the future though).

While the ocamldoc path renders ocaml's package quite well with this convention (see http://docs.mirage.io/ocaml/index.html). It fails quite badly on the odoc path (see http://docs.mirage.io/odoc/ocaml/index.html).

There are two reasons.

1. A lot of cmti files are installed for modules that are not part of the public API (at least their mli is not installed); those are mainly files in the compiler-libs/ directory.

2. It seems that the cmti files for otherlibs are not installed, e.g. bigarray.cmti, str.cmti, unix.cmti, etc. are all missing.