Documentation: how to debug the `No Docs` issue on ocaml.org package pages

Ecosystem
1

Hi!

ppx_minidebug 2.2.0 · OCaml Package does not display the documentation. The process I generate the documentation changed compared to ppx_minidebug 2.1.0 · OCaml Package but I don’t think that should be an issue?

What can I do to ensure the next version does publish with a documentation on ocaml.org, and maybe (even better) to restore documentation for the current version?

Thank You.

1 Like
2

Hi,

I am also interested to know how to debug the No Docs issue (for the Bitwuzla-cxx package for instance).
Is there a way to access the log and relaunch the build of the doc?

@avsm I’m sorry to bother you, but I think you might know something about it.

Best regards,
Frédéric

3

Here is a parent issue for No Docs: Documentation missing for some opam packages · Issue #1963 · ocaml/ocaml.org · GitHub

1 Like
4

Thank you. Now, I know what was the error during the doc generation (fortunately, not related to my package itself).
I hope they will rerun the all the failed build when the issue will be fixed.

1 Like
5

Why has no one pointed this site out? Am I stealing the reveal from the creators?

2 Likes
6

There’s a new version of this going live soon, so don’t spend too much time looking at the logs there. The PR for ocaml.org is here, so when that’s merged most of the missing docs will appear.

If you want to peek behind the curtain to see what’s going on, the new CI site is https://sage.caelum.ci.dev/ so you can see the status of the various docs builds there. The ‘packages’ and ‘passing’ pages can take a long time to load so be patient. The way the docs CI works is that it builds the documentation pages with odoc and serves them up over https. When you visit a docs page on ocaml.org, it loads the page from the docs CI server and ‘skins’ it with the ocaml.org HTML and sends that to the client - and that bit is already live. These pages are being served at https://sage.ci.dev/, but since the indexes are generated by the ocaml.org server, you can’t browse the output directly. However, if you just put in the package name and version into the url, you can see what’s been produced. For example, here is the ppx_minidebug documentation. This is all being done with odoc 3, so you get new features like source links and source rendering, search and so on.

Hopefully we’ll get the PR merged soon!

5 Likes