how to generate documentations with haddock?

Question

The project I am using does not have docs on Stackage (they're out of date). Here is the original one which is on verson 0.3

I was told I could generate docs with haddock. I have the source code on my computer (using git clone) version 0.4

The haddock web page was way too advanced.

For the beginner, once I am in my directory, how do I generate docs?

Thanks to one of the answer I made come progress, but here is an error message:

src/Reflex/Dom/Xhr.hs:154:0:
     error: missing binary operator before token "("
     #if MIN_VERSION_aeson(1,0,0)
     ^

It's not entirely clear what the problem is. You do not know how to generate the documentation as webpages? Or you have a question how to install it? Or you have a question about a specific feature in haddock? — Willem Van Onsem, Mar 23 '17 at 19:10
@WillemVanOnsem after I `git clone` what do I type into the shell to generate documentation? — john mangual, Mar 23 '17 at 19:20

score 5 · Answer 1 · answered Mar 23 '17 at 19:07

5

cabal haddock or stack haddock.

answered Mar 23 '17 at 19:07

Li-yao Xia

where are the documentations saved? – john mangual Mar 23 '17 at 19:18
1

@johnmangual At least for `stack haddock`, stack will tell you where the documentation is saved after you run `stack haddock`. – Alec Mar 23 '17 at 19:46

Willem Van Onsem · Accepted Answer · 2017-03-23T19:35:50.250

3

Once you have installed haddock, you can run it as follows:

haddock --html -o <haddock-folder> <list-of-haskell-files>

So for instance:

haddock --html -o the_documentation *.hs

will generate the documentation of all the Haskell files in that directory (not any subdirectories) in a directory named the_documentation.

Some shells allow **.hs to look for all .hs files (subdirectories included). So you might try:

haddock --html -o the_documentation **.hs

If the shell does not suport that, you can of course use a combination of find and xargs, like:

find -iname '*.hs' | xargs haddock --html -o the_documentation

Here find will generate a list of all files that end with .hs, and xargs will write all these files as parameters to haddock --html ....

edited Mar 23 '17 at 19:35

answered Mar 23 '17 at 19:23

Willem Van Onsem

yes I was about to say... how my Haskell files are buried in `*.hs` files at various depths. `find . -name "*.hs"` oh you got tat! – john mangual Mar 23 '17 at 19:33
can you tell `haddock` to skip files where haddock doesn't work? – john mangual Mar 23 '17 at 19:34
@johnmangual: I never encountered this error before. It looks like haddock is having problems with a "macro". – Willem Van Onsem Mar 23 '17 at 20:00
1

@johnmangual: does adding `--optghc='-cpp'` solves the issue? – Willem Van Onsem Mar 23 '17 at 20:02

2 Answers2