Repository files navigation

A toolset for Reason / OCaml related documentation generation

1. CloneBucklescript somewhere on your machine (for example at~/projects/bucklescript).
2. Follow the build instructions inCONTRIBUTING.md in the Bucklescript repository.
3. Installesy withnpm install -g esy.

Make sure you followed all the steps in the Requirements section first. Once that is done, you can build thebs-doc tool (this is a temporary name).

$ esy

And finally, run the tool to generate the documentation artefacts (e.g. JSON):

$ esy x -- bs-doc --output=_output --bs-project-dir=~/projects/bucklescript

This will generate JSON and odoc files in the_output folder. When regenerating the files, make sure to remove the previously created files.

For additional configuration options see:

$ esy x -- bs-doc --help

Currently the JSON generation is implemented in aforked version of odoc.

To work with the JSON generator, clone the forked version of odoc on your machine and build it with esyesy @ocaml-4.06.

To use the modified version of odoc, you can update thepackage.json file in this repository to link to the clonedodoc folder.