https://github.com/jfeser/odoc2docset

Create Dash docsets from Odoc generated documentation.
https://github.com/jfeser/odoc2docset

docset documentation ocaml

Last synced: about 1 month ago
JSON representation

Create Dash docsets from Odoc generated documentation.

• Host: GitHub
• URL: https://github.com/jfeser/odoc2docset
• Owner: jfeser
• License: mit
• Created: 2017-12-23T21:44:47.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2022-01-28T16:28:59.000Z (almost 3 years ago)
• Last Synced: 2024-11-05T05:33:53.625Z (about 2 months ago)
• Topics: docset, documentation, ocaml
• Language: OCaml
• Size: 98.6 KB
• Stars: 22
• Watchers: 4
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGES.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-starred-test - jfeser/odoc2docset - Create Dash docsets from Odoc generated documentation. (OCaml)

README

        
# odoc2docset

Converts [Odoc](https://github.com/ocaml-doc/odoc) generated documentation into

[Dash](https://kapeli.com/dash) (or [Zeal](https://zealdocs.org/)) docsets.

## Installation

```

opam pin add odoc2docset https://github.com/jfeser/odoc2docset.git

opam install odoc2docset

```

## Usage

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

```

### Compression

By default, `odoc2docset` will create uncompressed docsets. Compressed docsets

can be created using the `--compress` option. This mode requires

[tarix](https://github.com/fastcat/tarix/) and GNU tar.

## Known bugs

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.