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

Hackage trac at galois.com
Thu Jun 19 15:22:02 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:           
---------------------------------+------------------------------------------
Comment (by duncan):

 `--complete` isn't very helpful since we're likely to add other things in
 future like tests, tag files etc.

 The nearest thing we have at the moment is features like `configure
 --enable-library-profiling` which at configure time asks for things that
 will be done at build time. So perhaps we want:

 {{{
 cabal install foo --enable-haddock
 }}}

 but then do we also need to be able to control all the haddock flags?
 There are quite a few of them:

 {{{
 --hoogle            Generate a hoogle database
 --html-location=URL Location of HTML documentation for pre-requisite
                     packages
 --executables       Run haddock for Executables targets
 --internal          Run haddock for internal modules and include all
                     symbols
 --css=PATH          Use PATH as the haddock stylesheet
 --hyperlink-source  Hyperlink the documentation to the source code
                     (using HsColour)
 --hscolour-css=PATH Use PATH as the HsColour stylesheet
 }}}

 Should install just take the union of these things? What about when flags
 are ambiguous with another command? Both the `haddock` and `hscolour`
 commands have a `--css` flag.

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


More information about the cabal-devel mailing list