Central OPAM documentation site

Also regarding a more best-effort, “we can have now” approach. @gasche and others have been working this spring on trying to build as much opam packages as possible and as fast as possible. Using this work and a beefy machine a larger https://b0-system.github.io/odig/doc/ documentation set could be produced for a reasonably usable docs.ocaml.org by having something like:

  1. Fix a compiler version (say the penultimate one).
  2. Depending on available computing resources fix a frequency on which you checkout the current state of the opam repository.
  3. Using @gasche et al. work try to build a cover that includes each package at its latest version.
  4. Union the resulting libdir's of the cover elements always keeping the result for the latest version of the package if there are conflicts.
  5. odig odoc the resulting unioned libdir.

That “union” prefix will be broken compilation wise but should remain odiggable providing a best-effort docset for the all the packages at the latest versions in the ocaml-repository. Some inter-package links will be broken or absent — api changes or unresolvable .cmti file digests – but, depending on the actual result, maybe something we shouldn’t shy away to publish on docs.ocaml.org until we figure out better ways.

4 Likes