[Hackage] #206: cabal-install should be able to generate haddock docs

Hackage trac at galois.com
Wed Jun 18 22:31:55 EDT 2008


#206: cabal-install should be able to generate haddock docs
---------------------------------+------------------------------------------
  Reporter:  guest               |        Owner:           
      Type:  enhancement         |       Status:  new      
  Priority:  normal              |    Milestone:  Cabal-1.4
 Component:  cabal-install tool  |      Version:  1.2.3.0  
  Severity:  normal              |   Resolution:           
  Keywords:                      |   Difficulty:  normal   
Ghcversion:  6.8.2               |     Platform:           
---------------------------------+------------------------------------------
Changes (by guest):

 * cc: avatar at hot.ee (removed)
 * cc: gwern0 at gmail.com (added)

Comment:

 FWIW, I think Daniel's idea isn't quite right.

 In an ideal world, we could do configure && build && haddock && install -
 but lots of packages might not work. They may need 2.0 Haddock instead of
 0.8; they may use the -- ^ syntax for a 'type' declaration (a known
 regression in Haddock 2.0, and a fatal bug); or something else entirely.
 So documentation could *easily* fail to build even when the
 library/executable works perfectly.

 A better approach would be to build and install, and if that works, go
 back and try to build Haddocks in a way non-prejudical to the overall
 build process. (In my shell scripts, it looks something like "configure &&
 build && install; haddock && install".)

-- 
Ticket URL: <http://hackage.haskell.org/trac/hackage/ticket/206#comment:6>
Hackage <http://haskell.org/cabal/>
Hackage: Cabal and related projects


More information about the cabal-devel mailing list