[xmonad] the new documentation system

Andrea Rossato mailing_list at istitutocolli.org
Thu Nov 22 02:54:30 EST 2007


On Thu, Nov 22, 2007 at 12:57:28AM -0500, Devin Mullins wrote:
> Awesome work! If you're in the mood for meta-documentation, I'd love to
> read details on the toolchain necessary to generate these. IIRC, you
> using ghc 6.8 and darcs haddock? Any other gotchas? With these
> installed, does Setup.lhs haddock work as expected?
> 
> _Maybe_ that would encourage me to actually contribute, but no promises. :)

Sure! All you need is haddock-ghc (haddock-0.8 is fine too, but
there's an annoying bug with the X newtype deriving -in XMonad.Core -
which requires a very small patch). IIRC XMC docs should be generated
without problem.

You can get haddock-ghc from:
http://code.haskell.org/haddock

That's it: Setup.lhs haddock should be working fine... 

... almost. There seems to be an issue with that darcs version and the
option --hyperlink-source, which means: no links to the source code
are possible (and so no hscolour). Haddock-0.8 works fine in that
regard.

Hope this helps,

Andrea



More information about the xmonad mailing list