Generate docs with odoc

Dune provides builtin support for documentation generation with odoc. Generating Reason syntax with odoc is already possible. This means that we can generate documentation for any Reason+esy project!

There’re some things that need to be fixed first, in particular:

• Unattached docstring parsing currently seems to be broken in the Reason parser. (I’ll open a separate issue for this later.)
• Currently odoc generates OCaml syntax by default. We need to teach dune how to generate Reason syntax for docs (https://github.com/ocaml/odoc/issues/129).
  • This could be done by setting an environment variable
  • Or by generating Reason syntax for rei files
• The generated docs are currently placed in the _build/default/_doc/_html directory inside esy’s environment. I think asking users to go to that directory to open docs is not ideal.

I already started working on this and expect to have something functional soon.

CC @jordwalke @aantron

[andreypopp]

Thanks for looking into this! I’ve tried odoc with some of my esy-based projects and I really liked how it looks!

The generated docs are currently placed in the _build/default/_doc/_html directory inside esy’s environment. I think asking users to go to that directory to open docs is not ideal.

In the next esy version it would be possible to reference esy envs from a command line like this:

% esy x '#{self.doc}/_html/index.html'

I think we can add a script esy opendoc which does that.

[rizo]

I think this is done now. Or at least current master is in a good enough shape IMO.