Monadoc

dash-haskell

Version 1.1.0.2 revision 0 uploaded by johnfeltz.

Package meta

Synopsis
Convert package Haddock to Dash docsets (IDE docs)
Description

A Dash.app docset is a file-layout for allowing easy lookup and indexing of programming docs, e.g. API functions and modules. A number of plugins offer docset lookup in editors such as Emacs and Vim. By using this tool, one can convert haskell package haddock(s) to docsets.

The major benefit of dash-haskell, is that once these docsets are built, dash tools provide one of the few, if only solutions for offline, contextual, and project dependency approximate IDE documentation for Haskell.

Usage Examples:

$ dash-haskell parsec-3.1.5

builds:

./docsets/parsec-3.1.5.docset
$ dash-haskell -c foo.cabal -s

builds all packages listed as dependencies in the cabal file, using the default db ordering (global, sandbox, user).

Note: haddock documentation for the package must first be built prior to calling dash-haskell on it, e.g.

$ cabal install --only-dependencies --enable-documentation

Versions:

The version numbering scheme for this package is defined as follows, given:

dash-haskell-a.b.c.d

a, b index interface or feature changes to the CLI

c, d index bug-fix and documentation updates

Author
John P. Feltz
Bug reports
https://github.com/jfeltz/dash-haskell/issues
Category
Documentation
Copyright
(c) 2014, 2015 John P. Feltz
Homepage
http://www.github.com/jfeltz/dash-haskell
Maintainer
jfeltz@gmail.com
Package URL
n/a
Stability
n/a

Components