Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use of MLD files #5

Open
stevebleazard opened this issue Apr 17, 2018 · 3 comments
Open

Use of MLD files #5

stevebleazard opened this issue Apr 17, 2018 · 3 comments

Comments

@stevebleazard
Copy link

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?

@bobbypriam
Copy link
Owner

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.

@bobbypriam
Copy link
Owner

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.

@andreas
Copy link

andreas commented Mar 14, 2019

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants