Help with dune and odoc

Learning
#1

Hi

I’ve followed the instructions here:
https://jbuilder.readthedocs.io/en/latest/documentation.html

I’ve run dune build @doc and it does generate html, but all my function definitions are blank. I’ve tried adding some documentation comments above some functions and modules but it still generates empty files.

The project is here:

Any help would be appreciated
Thanks, Ryan

#2

You need to declare the libraries public for their documentation to be generated. You need to add a (public_name <library name>) to each library that you want to be publicly exposed.

I made a pull request with an example.

If you do intend for the libraries to be private you would need to invoke dune as dune build @doc-private as mentioned in the manual.

4 Likes
#3

Great, thanks for your help!

1 Like