haskell-docs: A program to find and display the docs of a name from a given module.
Given a module name and a name, it will find and display the documentation of that name.
$ 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.
You should ensure that you have
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.
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
Issues/ideas/contributions please make a Github issue: http://github.com/chrisdone/haskell-docs/issues
|Versions [RSS]||0.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, 4.2.3, 4.2.4, 4.2.5, 4.2.6, 4.2.7, 4.2.8, 4.2.9|
|Dependencies||base (>4 && <5), containers, ghc (>7.2 && <7.9), ghc-paths, haddock, haskell-docs, monad-loops, optparse-applicative [details]|
|Copyright||2012 Chris Done|
|Source repo||head: git clone git://github.com/chrisdone/haskell-docs.git|
|Uploaded||by ChrisDone at 2014-06-16T18:59:23Z|
|Downloads||20682 total (113 in the last 30 days)|
|Rating||(no votes yet) [estimated by Bayesian average]|
|Status||Docs available [build log]
Successful builds reported [all 1 reports]