We’re in the process of deploying odoc 3 on the package documentation pipeline that underpins the package documentation pages at OCaml Packages · Browse Community Packages . We’ve prepared a patch for OCaml.org that renders the packages’ documentation pages with the new odoc 3 features. Before deplo…

Thats great news ! I went to look at docs, and I have a few comments: [image] This does not look very good because its multi-line. Also the color highlight is not part of the color scheme which makes feel it a little off. I also think the line numbers are too large and bright, they’re not the m…

Thanks a lot Emile for the valuable feedback! And for your help on odoc 3. I’ll try to fix those issues before we merge then. (About the “visual” comments I have a disclaimer: I’m very not a designer, so I’ll do my best but … if anyone wants to help with a PR?) This does not look very good becaus…

[image] panglesd: However I don’t think @dbuenzli ’s packages do that. I don’t know if that is a choice to avoid having users depend on implementation details ? Rather, no one told me that I should.

So, once this PR is merged, to have your source be displayed in the docs, you need to install the .ml corresponding to your compilation units in order to have source rendered in the ocaml.org website! I think this should be added to the documentation, with more details. I’ll open an issue. (Note t…

[image] panglesd: This is not possible for packages which do not install source, which is not bad enough for me to open an issue. Except for cmdliner whose distribution is based on a Makefile so that it only depends on ocaml, that’s an issue with topkg, not with individual packages. Opening o…

[image] dbuenzli: Btw. anyone knows if there is an invocation to retrigger package that build depend on topkg in an opam switch ? Something like opam reinstall $(opam list -s --all-versions --installed --depends-on topkg) should do it

Good work on the new features! They’ll make exploring package docs easier. I noticed an issue when browsing the pages on mobile, the “Source” link looks like it is part of the signature: [image] This uses the exact same style as links which are part of the signature, and that can lead to unneede…

Thanks @dlesbre for your feedback! I have updated the style for the “link to source” button as per Emile’s comments, unfortunately it has still not yet been pulled on staging. I’ll ping @sabine about this. While the new style will definitely be better, I haven’t tested properly on mobile. I’ll work…

Thanks so much for the feedback and bug reports! :orange_heart: :two_hump_camel: I’ve just triggered the deployment of the current state of the PR (52d1860) to staging.ocaml.org , which includes fixes based @panglesd has made based on your reports. The patch should be live in around 15 minutes. (Ra…

[image] sabine: staging.ocaml.org This website seems to be down, at least for me.

Help Test the New Odoc-3-Powered Package Documentation Pages

Ecosystem

kit-ty-kate June 16, 2025, 1:54pm 7

Something like opam reinstall $(opam list -s --all-versions --installed --depends-on topkg) should do it

1 Like

Topic		Replies	Views
[ANN] Odoc 3 Beta Release Ecosystem announce , odoc	12	802	February 5, 2025
[ANN] Release of odoc 2.0.0 Ecosystem odoc	17	2175	February 6, 2022
[ANN] docs.ocaml.pro : an OCaml Documentation Hub Community announce , documentation	34	4633	April 28, 2021
New Odoc-3-Generated Package Documentation is Live on OCaml.org Community user-feedback , ocamlorg	4	213	July 14, 2025
[ANN] Release of odoc 2.3.0 Ecosystem announce , odoc	2	595	October 20, 2023

Help Test the New Odoc-3-Powered Package Documentation Pages

Related topics