Yesterday, doing runghc ./Setup.hs haddock in zlib.0.4.0.1, I noticed that no Haddock docs have been built for my 6.8.1. I followed the usual building steps, which worked with previous GHCs, set XMLDocWays=html, then ./configure make make install make install-docs No library docs (users guide and Cabal manual are fine). I looked around in a couple of Makefiles, tried 'make doc' in libraries, that built docs, but Haddock couldn't make any cross-package links and libraries/index.html links to package/Package-Name.html, which doesn't exist, because it's package/dist/doc/html/package/Package-Name.html. Question 1: How do I get proper library documentation? Question 2: When I build a package via Cabal, is there a way to merge the documentation into the installed library docs (and if yes, how do I do it)? Feature request: Could the README in future please contain information on how to build library documentation properly? Thanks, Daniel
Am Freitag, 30. November 2007 15:23 schrieb Daniel Fischer:
Question 2: When I build a package via Cabal, is there a way to merge the documentation into the installed library docs (and if yes, how do I do it)?
I think, if you do runhaskell Setup.[l]hs haddock before runhaskell Setup.[l]hs install then the latter installs the Haddock-generated API documentation and this documentation will be linked to by future Haddock-generated documentations when using Cabel to make them. Best wishes, Wolfgang
Am Freitag, 30. November 2007 18:04 schrieb Wolfgang Jeltsch:
Am Freitag, 30. November 2007 15:23 schrieb Daniel Fischer:
Question 2: When I build a package via Cabal, is there a way to merge the documentation into the installed library docs (and if yes, how do I do it)?
I think, if you do
runhaskell Setup.[l]hs haddock
before
runhaskell Setup.[l]hs install
then the latter installs the Haddock-generated API documentation and this documentation will be linked to by future Haddock-generated documentations when using Cabel to make them.
Best wishes, Wolfgang
Yes, thanks, that's what cabal always did, I just thought it would be nice to have all installed libraries together because that would facilitate deciding whether I use something from the containers package, or the collections package or edison. But that's less important, really important is, how do I get proper haddock docs built for my 6.8.x in the first place? Currently, haddock doesn't find anything to link the docs for additional packages against. Thanks, Daniel
Am Montag, 3. Dezember 2007 13:38 schrieben Sie:
[…]
I just thought it would be nice to have all installed libraries together because that would facilitate deciding whether I use something from the containers package, or the collections package or edison.
Do you mean you want a combined contents page and a combined index? Then have a look at libraries/gen_contents_index in the GHC 6.8.1 source tarball. You might want to reuse this script.
[…]
Best wishes, Wolfgang
On Fri, Nov 30, 2007 at 03:23:04PM +0100, Daniel Fischer wrote:
Yesterday, doing runghc ./Setup.hs haddock in zlib.0.4.0.1, I noticed that no Haddock docs have been built for my 6.8.1.
Feature request: Could the README in future please contain information on how to build library documentation properly?
Good point; I've added this to README: $ echo "XMLDocWays = html" > mk/build.mk $ echo "HADDOCK_DOCS = YES" >> mk/build.mk $ sh boot $ ./configure $ make $ make install $ make install-docs Thanks Ian
participants (3)
-
Daniel Fischer -
Ian Lynagh -
Wolfgang Jeltsch