ocaml-documentation-guideline Use of MLD files

I think a section on the use of MLD files to create documentation that isn't tied to a module or function would be useful. I for one am not to clear on how they are used and where the content appears in the output. Also, is a library.mld the natural place for the overview and starting examples?

Apr 17 '18 19:04 stevebleazard

Thank your for the feedback, and yes I've been meaning to get back to it later. While I'm unable to add it now (off to work in a minute), AFAIK one way to utilize it is via Dune (Jbuilder), see the section on Documentation Stanza at their official docs. It would be good to add this info at the Dune section of the document. A support for odig is tracked.

Apr 18 '18 02:04 bobbypriam

A short update to this, it would seem that we need to wait for ocaml/dune#717. If I got that working, then I'll add the steps to use .mld on the guide.

Apr 24 '18 15:04 bobbypriam

Looks like ocaml/dune#717 has been resolved. It would be great to add .mld usage to the guide 💯

Mar 14 '19 10:03 andreas