OCaml Docset for Dash

This is an alternative Dash docset for the OCaml language and its standard-library.

Compared to Dash's official docset for OCaml¹, this one:

• Is more up-to-date.
• Has better accuracy, in terms of which identifiers are successfully indexed and how they are categorized.
• Has better usability, e.g. the hierarchy of a page's sections is visualised in Dash's sidebar.

Generating the Docset

Important

The python3 (3.11+), curl and make commands must be available on your system.

Clone this repository and then run make in its directory.

The OCaml reference manual will automatically be downloaded, and then transformed into ./generated/ocaml-unofficial.docset.

Alternatively, the Docset can be generated for a specific version of OCaml (rather than the default version set in the Makefile), by running for example: OCAML_VERSION=5.2 make instead of make.

Installing the Docset

In the Dash application, choose Settings > Docsets > [+] > Add Local Docset and select the generated docset file mentioned above.

Or, in Finder, simply double-click the generated docset file.

Footnotes

1. As far as I can tell, the code that generates Dash's official docset for OCaml is not open-source, so this one is not derived from it. ↩