dash-haskell: Convert package Haddock to Dash docsets (IDE docs)
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
[Skip to Readme]
Downloads
- dash-haskell-1.1.0.2.tar.gz [browse] (Cabal source package)
- Package description (as included in the package)
Versions [RSS] | 1.0.0.0, 1.0.0.1, 1.0.0.2, 1.0.0.3, 1.0.0.4, 1.0.0.5, 1.1.0.0, 1.1.0.1, 1.1.0.2 |
---|---|
Dependencies | base (>=4.7 && <=4.9), Cabal (>=1.18.0), containers (>=0.5.5.1), direct-sqlite (>=2.3.13), directory (>=1.2.1.0), either (>=4.3), filepath (>=1.4.0.0), ghc (>=7.10.1), haddock-api (>=2.15.0), optparse-applicative (>=0.11.0.1), parsec (>=3.1.5), pipes (>=4.1.0), sqlite-simple (>=0.4.5.0), tagsoup (>=0.12.7), text (>=0.7.1), transformers (>=0.2 && <0.5) [details] |
License | LGPL-3.0-only |
Copyright | (c) 2014, 2015 John P. Feltz |
Author | John P. Feltz |
Maintainer | jfeltz@gmail.com |
Category | Documentation |
Home page | http://www.github.com/jfeltz/dash-haskell |
Bug tracker | https://github.com/jfeltz/dash-haskell/issues |
Source repo | head: git clone https://github.com/jfeltz/dash-haskell.git |
Uploaded | by johnfeltz at 2015-07-18T18:18:33Z |
Distributions | |
Reverse Dependencies | 1 direct, 0 indirect [details] |
Executables | dash-haskell |
Downloads | 6316 total (18 in the last 30 days) |
Rating | (no votes yet) [estimated by Bayesian average] |
Your Rating | |
Status | Docs not available [build log] Last success reported on 2015-12-12 [all 8 reports] |