[Haskell-cafe] Building Haddock on Windows

[Simon Marlow]

> Got it built after realising that my PATH didn't include ghc 
> (thanks Andy
> Moran). I renamed haddock.bin to haddock.exe and copied to 
> into ghc's bin
> for convenience (ghc's bin is already in my path). Now I just 
> have to figure out how to invoke it...
> 
> Where can I find instructions for use? I see haddock.sgml in
> haddock-0.6/haddock/doc but reading sgml hurts. Is there an 
> html version of this somewhere?

HTML docs are on the web:

   http://www.haskell.org/haddock/docs/haddock.html

Haddock is designed to be installed via 'make install', and then run
using the script named 'haddock' in $prefix/bin.  You *can* run the
binary directly, but you'll need to pass it some extra arguments so that
it can find its files.

> I have a few questions:
>  - can you invoke it on a folder and have it generate docs 
> for all of the
> source files in it (and sub-folders)?
>  - does it work on .lhs source containing bird-track style 
> code? It would
> appear not, as I get a parse error. 

These Qs are answered in the docs.

>  - why doesn't it know what Int, String, Float, IO, Monad, 
> Show, etc are?
> What invocation option do I need to ensure it links to
> Prelude/hierarchical-library stuff? (I think it's 
> --read-interface; must I
> generate interface files for the Prelude and libraries though?)

You get the interfaces for the libraries with a GHC installation.  Just
use the --read-interface flag to tell Haddock about them.

Cheers,
	Simon