Skip to content

Add support for Reason doc generation #1117

@rizo

Description

@rizo

(Continued from ocaml/odoc#156 (comment))

We recently introduced support for Reason syntax generation in odoc.

Specifically, the following option is now implemented:

$ odoc html [--syntax=<ml|re>]   (default=ml)

It would be great if dune had the ability to pass this option to odoc and thus allow users to generate either or both syntaxes.

A few options were discussed:

  1. Introduce different targets for each syntax: @doc and @reason-doc (suggested by @rgrinberg).
  2. Decide which syntax to generate based on the file extension (suggested by @diml).

The second option seems very natural and doesn't require user-facing changes but it also doesn't allow the generation of both syntaxes at the same time.

Note: The --lang option mentioned in this issues was renamed to --syntax.

Metadata

Metadata

Assignees

Labels

odocIssues and PRs related to documentation generation with odoc

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions