Skip to content

Latest commit

 

History

History
33 lines (20 loc) · 1.54 KB

README.md

File metadata and controls

33 lines (20 loc) · 1.54 KB
Raw

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 OCaml1, 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 the Sections within a page is preserved in the sidebar.

Screenshot of Dash showing the Stdlib module in this docset

Generating the Docset

Important

The python3 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

Installing the Docset

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

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. ↩