The haskell-docs package

[Tags: bsd3, library, program]

Given a module name and a name, it will find and display the documentation of that name.

EXAMPLE USAGE

 $ haskell-docs Data.List.Split split
 Split a list according to the given splitting strategy. This is
  how to "run" a Splitter that has been built using the other
  combinators.

INSTALLATION

You should ensure that you have

 documentation: True

in your .cabal/config so that the necessary .haddock files are generated.

Haddock is very sensitive to the GHC version, and so too will this program be, to GHC, and to Haddock. I suggest installing like this:

 cabal install haskell-docs --constraint haddock==2.10.0

But replace the 2.10.0 with the version that haddock --version gives you.

I could perhaps instead have a flag for each GHC release back a few versions.

USING WITH GHCI

 > :def doc \input -> return (":!haskell-docs " ++ input)
 > :doc System.IO getContents base
 The getContents operation returns all user input as a single string,
  which is read lazily as it is needed
  (same as hGetContents stdin).

Add the above :def to your user .ghci to have it on start-up.

CONTRIBUTION AND ISSUES

Issuesideascontributions please make a Github issue: http://github.com/chrisdone/haskell-docs/issues


Properties

Versions0.1.0.0, 0.1.1.0, 0.2.0.0, 3.0.0, 3.0.2, 3.0.3, 4.0.0, 4.1.0, 4.1.1, 4.1.2, 4.1.3, 4.1.4, 4.1.5, 4.2.0, 4.2.1, 4.2.2
Dependenciesbase (>4 && <5), containers, ghc, ghc-paths, haddock, monad-loops
LicenseBSD3
Copyright2012 Chris Done
AuthorChris Done
Maintainerchrisdone@gmail.com
CategoryDevelopment
Home pagehttp://github.com/chrisdone/haskell-docs
Bug trackerhttp://github.com/chrisdone/haskell-docs/issues
Source repositoryhead: git clone git://github.com/chrisdone/haskell-docs.git
Executableshaskell-docs
UploadedThu Dec 27 01:31:06 UTC 2012 by ChrisDone
Downloads4012 total (263 in last 30 days)
StatusDocs not available [build log]
All reported builds failed [all 1 reports]

Downloads

Maintainers' corner

For package maintainers and hackage trustees