Hi all, I would like the documentation of my packages to be available on ocaml.org , but I can’t find the info on the requirements for that. Local doc generation works (simply invoking dune build @doc) but it seems it is not enough :slight_smile:!

You don’t need to do anything beyond have it in the ocaml/opam-repository. However, some packages do not build due to missing depexts or similar problems (which is why we’re so big on making sure that package submissions pass the automated build tests when merging them). Which package doesn’t buil…

I don’t know how to do it myself, but I think the title of this topic should be changed as follows: s, on , to , otherwise it is easy to misread as being about getting or downloading existing docs. – Ian

Right, I see it now :slight_smile: I should add that I mean packages that are already available on opam.

Hi Anil, this one , but it’s all clear now: I remember there was some difficulties with the gsl package, which is needed by biotk. For some reason the installation of gsl failed at that time and it was not possible to have a complete build for biotk. I’ll make a new release and see if anything needs…

it seems that packages that used to have their docs on ocaml.org now say “No Docs”. For instance tsdl 1.0.0 · OCaml Package tsdl 1.0.0: Thin bindings to SDL for OCaml bogue 20221112 · OCaml Package bogue 20221112: GUI library for ocaml, with ani…

Another example is https://ocaml.org/p/dream-html/latest/doc/index.html This relies only on Dream (so, perhaps something in the transitive dependency cone is causing a build failure).

How to make the documentation of a package available on ocaml.org

Learning

dbuenzli September 14, 2023, 6:13pm 7

Regarding those packages that depend on sdl see @sabine’s message here.

Topic		Replies	Views
Documentation for OPAM packages? Learning opam , docs	7	2389	December 28, 2017
Missing ocaml.org package documentation Site Feedback	4	230	April 14, 2026
Deploy documentation with dune Ecosystem opam , documentation , dune	2	859	August 23, 2022
Documentation options when odig doesn't work Learning documentation	2	916	December 8, 2017
Documentation: how to debug the `No Docs` issue on ocaml.org package pages Ecosystem	5	254	June 2, 2025

How to make the documentation of a package available on ocaml.org

Related topics