New Odoc-3-Generated Package Documentation is Live on OCaml.org

Hi everyone,

I just merged the patch feat: use output from new doc-ci with odoc 3 features in the package documentation area by panglesd · Pull Request #3124 · ocaml/ocaml.org · GitHub which enables the new and improved package documentation built with odoc 3 on OCaml.org. Thanks @mtelvers, @jonludlam, @panglesd for putting in the effort to make this happen for OCaml.org!

Thanks to everyone who gave us feedback when we ran this on the staging environment (Help Test the New Odoc-3-Powered Package Documentation Pages - #6 by dbuenzli), we’re reasonably confident that things work well enough to apply this upgrade. :orange_heart:

In case you see something that could be improved, please let us know (by replying here or by opening an issue on GitHub - ocaml/ocaml.org: The official OCaml website.)!

Cheers
Sabine

10 Likes

Excellent stuff, thanks everyone!

I just noticed an oddity with the Eio docs: the spawn docs link to Fork_action.t which is a 404 on the live website (it was before the change from odoc 2->3 as well, so might be something else causing this).

Thanks for the report, @avsm! I’m aware that it’s not at all clear how to report problems like this right now, so I’m currently working on making it clearer how to do so. The short version is something like this:

If a package doesn’t have any docs at all, look at the logs on the service running the docs CI, sage. The logs for individual packages can be found at https://sage.caelum.ci.dev/package/<name>.<version>, (e.g. https://sage.caelum.ci.dev/package/odoc.3.0.0). The problems there might be that the solver failed to find a solution for the package (e.g. all mirage-net-macos solves fail because all the jobs are currently running on linux), or there was a problem during the build (e.g. vhd-format.0.12.1 fails due to an API mismatch with cstruct). These issues should be reported either to the package itself, or with the docs CI project.

If the docs are actually present but there’s a problem with them, as is the case with eio_linux here, the problem is more likely to do with odoc itself. Unfortunately these can still be very difficult to diagnose, so the best thing to do here is to create an issue, and I or someone else on the odoc team will take a look.

2 Likes

Could we have a more useful No Docs button that links directly on the CI ?

For example I’m a little bit unsure with vg.0.9.5 has no docs while vg.0.9.4 has.

2 Likes

Could we have a more useful No Docs button that links directly on the CI ?

Definitely - this is precisely what @cuihtlauac and I were discussing on Friday.

For example I’m a little bit unsure with vg.0.9.5 has no docs while vg.0.9.4 has.

Me too - they seem to be there now though, but I can confirm when I first looked after you mentioned it they weren’t there! I’ll add this to the list of things to fix/consider in my quest to make diagnosing issues easier.

4 Likes