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.

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

1 Like

Topic		Replies	Views
Documentation created by dune build @doc looks ugly Learning dune , odoc	7	642	December 21, 2023
Generating documentation of private libraries with dune Ecosystem dune	2	528	December 4, 2023
How to document an ocaml application Learning odoc	7	1343	November 18, 2020
Documenting library usage examples with odoc Ecosystem odoc	9	1618	August 6, 2022
Browsing offline library documentation in dune projects? Learning dune	1	133	April 12, 2025

How to get pleasant documentation for a library using Dune?

Related topics