[Haskell-cafe] lost the ability to provide haddocks for hackage

Olaf Klinke olf at aatal-apotheke.de
Fri Jul 16 08:30:15 UTC 2021

Dear Cafe, 

it seems I lost the ability to provide documentation for my hackage packages. While it is known that hackage sometimes fails to build documentation, the upload page [1] provides a guide to build and upload documentation. Stack does not have this ability yet [2] but it has the convenient option --no-haddock-deps that I can use as last resort when a dependency fails to build its Haddocks. I'd rather present documentation with broken links than no documentation at all. Cabal does not seem to provide such an option, while adding --keep-going and/or --enable-per-component to the suggested cabal command in [1] still aborts when one dependency fails to build. 

Is there something I've missed? If there is a way to build hackage-documentation in presence of haddock errors in dependencies, please someone update [1] and [3]. Can [4] be used to circumvent my problem? Perhaps add a guide to tweak the links generated by stack haddock to be hackage-compatible, as suggested in [2]? 

Strangely, the dependency package my cabal v2-haddock command fails on does have documentation on hackage. Would it be possible to pull these docs from hackage and use as a drop-in replacement? 


[1] https://hackage.haskell.org/upload
[2] https://github.com/commercialhaskell/stack/issues/737
[3] https://cabal.readthedocs.io/en/3.4/cabal-commands.html#cabal-v2-haddock
[4] http://neilmitchell.blogspot.co.uk/2014/10/fixing-haddock-docs-on-hackage.html

More information about the Haskell-Cafe mailing list