QCheck 0.90/0.91: missing documentation

[sir4ur0n]

Context: c-cube/qcheck#400

Context: ocaml/opam-repository#29149

It seems that versions 0.90 and 0.91 were recently published, however the documentation is not published on https://ocaml.org:

• 0.90 documentation
• 0.91 documentation

This is even more problematic as apparently several functions have been renamed (e.g. Gen.frequency -> Gen.oneof_weighted) so developers can't just browse 0.27 documentation.

[jmid]

A quick search on Discuss revealed this thread and in particular an informative post from @jonludlam:
https://discuss.ocaml.org/t/new-odoc-3-generated-package-documentation-is-live-on-ocaml-org/16967/3

I therefore tried the URL https://sage.caelum.ci.dev/package/qcheck.0.90
and found this workflow with a build failure: https://sage.caelum.ci.dev/job/2025-12-20/025819-voodoo-prep2-0fcb28

It seems to arise from this line https://github.com/jonludlam/opamh/blob/main/opam.ml#L61
and from opam's CHANGELOG it seems OpamStd.String.starts_with was removed in opam.2.5.0
released on Nov 25 ocaml/opam-repository#28978

To test my hypothesis that all documentation workflows that has run since Nov 25 are broken,
I had a look at another example release from the same time span: yocaml.2.8.0 from ocaml/opam-repository#29101 and indeed

• https://ocaml.org/p/yocaml/2.8.0 shows No Docs too, whereas 2.7.0 doesn't and
• https://sage.caelum.ci.dev/package/yocaml.2.8.0 shows a failed workflow run too with the same error:
  https://sage.caelum.ci.dev/job/2025-12-15/113824-voodoo-prep2-1f8bf9

So it seems opamh needs to be fixed - and the documentation workflows from the last month or so needs rerunning.

I propose sending a notification to an appropriate maintainer when such CI workflows fail 🙂

[jmid]

I've just opened jonludlam/opamh#1 to help get documentation generation going again.

[jmid]

FWIW, I've learned that document building is handled by
https://github.com/ocurrent/ocaml-docs-ci and
https://github.com/ocaml-doc/voodoo

I haven't figured out where opamh.dev is pinned though... 🤔

[katrinafyi]

Hi, I'm also chasing down broken docs atm :) It sounds like this problem was to do with new package builds? I'm seeing that on ocaml.org, every package page is showing "No Docs", for example: https://ocaml.org/p/qcheck-core/0.27/doc/index.html. I can't find a package which has working docs at the moment.

I have lots of links in my browser history to API pages which are broken now:

• https://ocaml.org/p/base/v0.17.1/doc/Base/Map/index.html
• https://ocaml.org/p/uri/latest/doc/src/uri/uri.ml.html#val-to_string
• https://ocaml.org/p/zarith/1.12/doc/zarith/Z/index.html#val-extract
• https://ocaml.org/p/qcheck-core/latest/doc/src/qcheck-core/QCheck.ml.html#module-Gen.val-big_nat
• https://ocaml.org/p/ocamlgraph/2.1.0/doc/ocamlgraph/Graph/XDot/index.html

Do you think this is the same issue or a different issue?

edit: all seems to be fixed now, maybe it was just an unlucky time.

[cuihtlauac]

@jonludlam: Where should we migrate this issue?

[jmid]

This has now been fixed https://ocaml.org/p/qcheck-core/latest
so this issue can be closed again.