Hi,
In some packages, I have a (often long) comment at the bottom of the .mli
file — unattached to any element — that gives some general information or some tips about the module. What it the recommended way of having it taken into account by odoc
?
Best,
C.
ATM, I am using an index.mld
but the problem is that cross-references between the index and modules are not properly resolved.
I use this pattern in quite a few places in my modules and I don’t think I ever saw this problem. Could you please file an issue with a way to reproduce odoc
’s issue tracker ?
There are quite a few reasons why this might be the case. Do you see that both if you generate with dune
and odig
(do an opam pin . && odig doc -u YOURPKG
) ? Are your cross references inter-packages ?