Converts Odoc generated documentation into Dash (or Zeal) docsets.
opam pin add odoc2docset https://github.com/jfeser/odoc2docset.git
opam install odoc2docset
To generate documentation for all installed packages, run:
odoc2docset Opam.docset
To generate documentation for a subset of packages, run:
odoc2docset Opam.docset pkgA pkgB pkgC
By default, odoc2docset
will create uncompressed docsets. Compressed docsets
can be created using the --compress
option. This mode requires
tarix and GNU tar.
Running this tool to update an existing docset while Dash is running can fail, because the Sqlite database does not support concurrent accesses. If the tool crashes with a Sqlite BUSY exception, quit Dash and try again.