ocaml.org icon indicating copy to clipboard operation
ocaml.org copied to clipboard

Documentation missing for some opam packages

Open art-w opened this issue 1 year ago • 5 comments

I looove that ocaml.org provides easily accessible documentation for all opam packages, and I use it daily. But some time ago (weeks? months?), I started seeing more and more packages where the documentation wasn't available (or at least, for their latest release... leaving me hunting through the dropdown menu to find an older version with documentation)

I did a quick inspection to see if I'm just being unlucky: (full listing: package_doc.txt )

  • 2'133 packages have documentation for all their versions :tada:
  • 1'170 packages have documentation for their latest version (but are missing some older ones, which is less critical)
  • 274 packages do not have documentation for their latest version (but have doc for some older versions, if you can find them in the dropdown menu...)
  • 825 packages do not have documentation at all for any version... this count includes binaries for which it's expected that's there's no odoc documentation, but there's a number of libraries in there too! (this count does exclude the 179 conf- packages with no doc)

How can we help? I don't know where to find debugging information about why documentation failed to build for a given package.

art-w avatar Jan 17 '24 14:01 art-w

https://docs.ci.ocaml.org/package has a list of all the failing package docs with build logs. This might be interesting.

sabine avatar Jan 18 '24 11:01 sabine

There also seems to be issues which are only detected when producing the html documentation, and were not reported in my counts or the logs of failing packages... Out of 30k opam releases, 5k are lost during solver/compilation + 5k during the html generation so about 1/3 is missing in total.

It's weird because the late failures display their errors on ocaml.org (rather than a 404) but they don't match their CI logs outcome, even though the html / logs files were generated at the exact same time. For example:

  • The latest bonsai.v0.16.0 failed due to a lack of disk space (?.. but no such errors on https://docs.ci.ocaml.org/package/base.v0.16.0 )
  • z3.4.8.8 failed because of a missing dependency (?.. but its logs are also looking good https://docs.ci.ocaml.org/package/z3.4.8.8 )

art-w avatar Feb 11 '24 15:02 art-w

Thanks @art-w, this looks like another thing to dig into to uncover what's actually going on here with these error pages (which appear to be generated by voodoo).

sabine avatar Feb 11 '24 21:02 sabine