[Hackage] #534: cabal haddock should --hyperlink-source by default
#534: cabal haddock should --hyperlink-source by default ----------------------------------+----------------------------------------- Reporter: adamvo | Owner: Type: enhancement | Status: new Priority: normal | Milestone: Component: Cabal library | Version: 1.6.0.1 Severity: normal | Keywords: Difficulty: very easy (<1 hour) | Ghcversion: Platform: | ----------------------------------+----------------------------------------- The results from cabal haddock --hyperlink-source are very nice, but quite frequently the haddocks are not built with this (all recent hackage libs iirc). Would there be a problem with generating the source links by default if and only if a HsColour can be found? Or should this issue instead be resolved at the haddock level? -- Ticket URL: http://hackage.haskell.org/trac/hackage/ticket/534 Hackage http://haskell.org/cabal/ Hackage: Cabal and related projects
#534: cabal haddock should --hyperlink-source by default ----------------------------+----------------------------------------------- Reporter: adamvo | Owner: Type: enhancement | Status: new Priority: normal | Milestone: _|_ Component: Cabal library | Version: 1.6.0.1 Severity: normal | Resolution: Keywords: | Difficulty: very easy (<1 hour) Ghcversion: | Platform: ----------------------------+----------------------------------------------- Changes (by duncan): * milestone: => _|_ Comment: The hackage libs do all have the sources. You're thinking of the docs that were built with ghc 6.10.1. That mistake has been corrected. My personal opinion is that nothing need changing. I'll leave the ticket open to give others a chance to comment. -- Ticket URL: http://hackage.haskell.org/trac/hackage/ticket/534#comment:1 Hackage http://haskell.org/cabal/ Hackage: Cabal and related projects
#534: cabal haddock should --hyperlink-source by default ----------------------------+----------------------------------------------- Reporter: adamvo | Owner: Type: enhancement | Status: new Priority: normal | Milestone: _|_ Component: Cabal library | Version: 1.6.0.1 Severity: normal | Resolution: Keywords: | Difficulty: very easy (<1 hour) Ghcversion: | Platform: ----------------------------+----------------------------------------------- Comment (by coeus): I like the hyperlinked sources, too. For this, I abuse cabal-install in bash scripts to download packages and their dependencies from hackage, because the following is still not possible: cabal install --hyperlink-source packagename I always have to unpack, configure, build, and "haddock --hyperlink- source" each package, just to have the sources hyperlinked. I don't know any other solution to this. Imho, it would be nice to have an option for that default behaviour in the config file. "documentation: True" is just not enough. -- Ticket URL: http://hackage.haskell.org/trac/hackage/ticket/534#comment:2 Hackage http://haskell.org/cabal/ Hackage: Cabal and related projects
Imho, it would be nice to have an option for that default behaviour in
#534: cabal haddock should --hyperlink-source by default ----------------------------+----------------------------------------------- Reporter: adamvo | Owner: Type: enhancement | Status: new Priority: normal | Milestone: _|_ Component: Cabal library | Version: 1.6.0.1 Severity: normal | Resolution: Keywords: | Difficulty: very easy (<1 hour) Ghcversion: | Platform: ----------------------------+----------------------------------------------- Comment (by duncan): Replying to [comment:2 coeus]: the config file. "documentation: True" is just not enough. Indeed. The implementation is unlikely to be difficult. All we are waiting for is for someone to come up with a coherent design. The existing ticket is: #517. Making the default be `--hyperlink-source` is just a cop-out for not properly addressing the above ticket. -- Ticket URL: http://hackage.haskell.org/trac/hackage/ticket/534#comment:3 Hackage http://haskell.org/cabal/ Hackage: Cabal and related projects
participants (1)
-
Hackage