haskell-docs: A program to find and display the docs of a name from a given module.

[ bsd3, development, library, program ] [ Propose Tags ]

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


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


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. This program tries not to be. If you cannot install this package due to a version problem, open a Github issue. If the versions match up but the build fails, open a Github issue. Neither case should arise.


> :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.


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

Versions,,, 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, 4.2.3, 4.2.4, 4.2.5, 4.2.6, 4.2.7, 4.2.8
Dependencies base (>4 && <5), Cabal, containers, ghc (>=7.2 && <7.9), ghc-paths, haddock, haskell-docs, monad-loops [details]
License BSD-3-Clause
Copyright 2012 Chris Done
Author Chris Done
Maintainer chrisdone@gmail.com
Category Development
Home page http://github.com/chrisdone/haskell-docs
Bug tracker http://github.com/chrisdone/haskell-docs/issues
Source repo head: git clone git://github.com/chrisdone/haskell-docs.git
Uploaded by ChrisDone at Fri Jun 20 23:27:10 UTC 2014
Distributions NixOS:4.2.8
Executables haskell-docs
Downloads 10907 total (35 in the last 30 days)
Rating (no votes yet) [estimated by rule of succession]
Your Rating
  • λ
  • λ
  • λ
Status Docs uploaded by user
Build status unknown [no reports yet]
Hackage Matrix CI




Maintainer's Corner

For package maintainers and hackage trustees