ocaml / camlp-streams

The Stream and Genlex libraries for use with Camlp4 and Camlp5
Other
15 stars 6 forks source link

empty documentation #10

Open gasche opened 1 year ago

gasche commented 1 year ago

https://ocaml.org/p/camlp-streams/latest/doc/index.html#camlp-streams shows empty documentation. I don't understand how ocaml.org/p/ is generated, but I would hazard the guess that the programming Dune file may be causing the absence of documentation. I would expect the documentation of the modules in src/ to be shown. Does some Dune wizard know how to get this?

(I came to this question from an end-user request at https://github.com/ocaml/ocaml/issues/5211#issuecomment-1722403664 )

gasche commented 1 year ago

Note: in the meantime https://v2.ocaml.org/releases/4.14/api/Genlex.html and https://v2.ocaml.org/releases/4.14/api/Stream.html have the documentation, we could link to those pages from the README or even in the opam metadata.

On the other hand, the "current" links to the module documentation given in the past, such as http://caml.inria.fr/pub/docs/manual-ocaml/libref/Genlex.html , redirect to https://v2.ocaml.org/api/Genlex.html which is just a blank page.

nojb commented 1 year ago

I just checked and the standard dune build @doc in this repository generates the documentation correctly. So that part seems to be working, maybe it is more of an issue with ocaml.org itself (not sure who we should ping).

dra27 commented 1 year ago

Ping @jonludlam and @sabine just to determine who should own the issue 🙂. The module documentation is on ocaml.org at https://ocaml.org/p/camlp-streams/latest/doc/Stream/index.html and https://ocaml.org/p/camlp-streams/latest/doc/Genlex/index.html so the confusion is why https://ocaml.org/p/camlp-streams/latest/doc/index.html has no index.

nojb commented 1 year ago

Thanks @dra27! Over at ocaml.org, "unknown lib" looks fishy:

image

dra27 commented 1 year ago

Given the contortions that the build has to go through to work on all 4.x versions correctly, I'm wondering if the dynamic dune file may be implicated - in which case, it would be interesting to know if #8 also happens to fix the docs on ocaml.org.

sabine commented 1 year ago

On first glance, it looks like https://github.com/ocaml-doc/voodoo is failing to generate the module tree. camlp-streams is not the only package, but I don't exactly remember where I've seen it before. I opened an issue to track this.

jonludlam commented 1 year ago

https://github.com/ocaml-doc/voodoo/pull/126 addresses this hopefully.