I’m working to publish a small library using Dune. The documentation automatically generated by dune build @doc looks fairly unpleasant to me, as I don’t see an easy way to explain what the library is about. I’m creating this topic in case I am missing something simple, and to get other people to sh…

I think the documentation of Streaming is a great example of the option 1 you describe. The corresponding Dune setup can be found here That’s also the approach we took for Opium’s documentation , although the index page is certainly not as impressive as Streaming’s.

Thanks! It looks like these systems rely on an undocumented feature of the (documentation) stanza (or odoc), which is that a user-provided index.mld file will implicitly replace the automatically-generated index.mld file, giving a reasonably natural result. The opium documentation also uses the {!m…

[image] gasche: It looks like these systems rely on an undocumented feature of the (documentation) stanza (or odoc), which is that a user-provided index.mld file will implicitly replace the automatically-generated index.mld file, giving a reasonably natural result. I confirm this feature is h…

[image] gasche: which is that a user-provided index.mld file will implicitly replace the automatically-generated index.mld file, giving a reasonably natural result. This is also the correct way to customize the landing page of your package for odig generated doc sets, see here for more inform…

[image] gasche: ¹: I’m ashamed to admit that I wasn’t aware of this very nice library Streaming , am I consuming the wrong sources of information on the OCaml ecosystem? You are in the right place, Streaming was announced[1] here :slight_smile: [1] [ANN] First release of streaming

I sent a PR to better document the use of index.mld in the Dune documentation: dune#4146 .

How to get pleasant documentation for a library using Dune?

Learning

yawaramin January 20, 2021, 2:55pm 6

You are in the right place, Streaming was announced[1] here

[1] [ANN] First release of streaming

Topic		Replies	Views
Generating documentation of private libraries with dune Ecosystem dune	2	582	December 4, 2023
Confusion about code structuring, dune, ocamlformat, ocamldoc (overall workflow) Learning ocamldoc , ocamlformat , dune	1	129	January 23, 2026
Dune, odoc and "failed to resolve reference" Ecosystem dune , odoc , beginner	7	148	April 12, 2026
How to use a custom generator for odoc in dune? Ecosystem dune , odoc	10	565	April 4, 2024
`dune build @doc` generates nothing Ecosystem dune	15	1195	January 10, 2024

How to get pleasant documentation for a library using Dune?

Related topics