dune icon indicating copy to clipboard operation
dune copied to clipboard
verified publisher icon ocaml

doc: Move glob syntax to dune-glob (#7988)

Open moyodiallo opened this issue 2 years ago • 8 comments

Fixes #7988

moyodiallo avatar Feb 28 '24 11:02 moyodiallo

Thanks.

  • This requires odoc >= 2.3.0 so I'm not sure if it will rendered properly by ocaml.org. @sabine do you know?
  • (we'll also need to mention that in dune-glob's opam file)
  • We can probably link to the docs from dependency-spec.rst instead of duplicating this information.

emillon avatar Feb 28 '24 14:02 emillon

We can probably link to the docs from dependency-spec.rst instead of duplicating this information.

If it's rendered properly IMHO we could go with that. If I'm not mistaken, at some point it could end up as broken link.

moyodiallo avatar Feb 28 '24 15:02 moyodiallo

Doesn't this add odoc as a build dependency? Is that really what is needed? Shouldn't it still be with-doc?

Alizter avatar Feb 29 '24 10:02 Alizter

Doesn't this add odoc as a build dependency? Is that really what is needed? Shouldn't it still be with-doc?

Indeed it should be with-doc. Changed in https://github.com/ocaml/dune/commit/d79aa829468500e6b87f10ff17b05adb1cd24d13

moyodiallo avatar Feb 29 '24 11:02 moyodiallo

This requires odoc >= 2.3.0 so I'm not sure if it will rendered properly by ocaml.org. @sabine do you know?

if it requires odoc >= 2.3.0, this will require https://github.com/ocaml-doc/voodoo/pull/128 to merge first. This patch is currently on https://staging.docs.ci.ocamllabs.io/ and someone needs to check if all the packages build as expected after the odoc upgrade - only after that, we can merge https://github.com/ocaml-doc/voodoo/pull/128.

ETA: a list of failing packages is here: https://staging.docs.ci.ocamllabs.io/package

Tezos packages failing is normal. I restarted all failed jobs.

sabine avatar Mar 16 '24 14:03 sabine

Thanks @sabine ! I subscribed to the PR and will hold this one until it's merged.

emillon avatar Mar 18 '24 16:03 emillon

Thanks @sabine for the merge of https://github.com/ocaml-doc/voodoo/pull/128.

You could start the review @emillon.

moyodiallo avatar Mar 27 '24 13:03 moyodiallo

That the pull request on voodoo has been merged does not mean that the deployment is successful. The voodoo patch has only been tested on all the newest versions of all the packages.

It's okay to go ahead with reviewing this, but I would ask you to wait with a merge until after we know that the deployment is successful. For reference, the previous voodoo version succeeded to build documentation for 22939 packages and failed to build the documentation of 808 packages.

The documentation pipeline at https://docs.ci.ocaml.org will start in roughly an hour to build all package documentation with the new voodoo version.

sabine avatar Mar 27 '24 13:03 sabine