Hackage :: [Package]

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

This is a package candidate release! Here you can preview how this package release will appear once published to the main package index (which can be accomplished via the 'maintain' link below). Please note that once a package has been published to the main package index it cannot be undone! Please consult the package uploading documentation for more information.

[maintain] [Publish]

Warnings:

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

Haddock's dependencies are useless, so here are recommended installation 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

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

Properties

Versions 0.1.0.0, 0.1.1.0, 0.2.0.0, 3.0.0, 3.0.2, 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
Change log None available
Dependencies base (>4 && <5), containers, ghc (>7.2 && <7.9), ghc-paths, haddock (>=2.9 && <2.15), haskell-docs, monad-loops, optparse-applicative [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 2014-06-16T18:44:21Z

Modules

[Index]

Downloads

Maintainer's Corner

Package maintainers

For package maintainers and hackage trustees