Skip to content


Subversion checkout URL

You can clone with
Download ZIP
branch: master
Fetching contributors…

Cannot retrieve contributors at this time

48 lines (42 sloc) 2.286 kb
name: docidx
version: 1.1.0
license: BSD3
license-file: LICENSE
category: Documentation
copyright: Andy Gimblett <>, Andy Price <>
author: Andy Gimblett <>, Andy Price <>
maintainer: Andy Gimblett <>
synopsis: Generate an HTML index of installed Haskell packages and their documentation.
cabal-Version: >=1.6
build-type: Simple
docidx is a small tool which creates an HTML index of your
installed Haskell packages, with links to each package's Haddock
docs locally and on Hackage. While "cabal install" now creates
and maintains an index by module, sometimes it's nice to have this
other view (and the quick links to Hackage).
docidx queries your global and user package databases (via
ghc-pkg, via the Cabal package), to build an index of all
installed packages - including version numbers where more than one
version is present, package synopses, links to the local Haddock
docs, and a link to the package on Hackage.
Packages are grouped by first letter, and there's an A-Z index at
the top of the page, which can be easily extended via a config
file to include extra links you think are handy - e.g. to the
per-module index, to local ghc documentation, to the Haskell
report, etc. - whatever you want).
executable docidx
hs-source-dirs: src
main-is: docidx.hs
build-depends: base >= 4 && < 5, Cabal >= 1.16, containers >= 0.3,
directory >= 1.0, filepath >= 1.1, html >= 1.0,
MissingH >= 1.1, mtl >= 2, old-locale, tagsoup >= 0.11,
time >= 1.1
other-modules: Distribution.DocIdx.Common, Distribution.DocIdx.Config,
Distribution.DocIdx.Html, Distribution.GhcPkgList
ghc-options: -fwarn-tabs -Wall
source-repository head
type: git
Jump to Line
Something went wrong with that request. Please try again.