Getting Haddock docs onto Hackage (using Stack)

A package I uploaded to Hackage a week ago still has no docs. (It says "Docs pending" and "Build status unknown".) What is the best way to get Haddock documentation for a package onto Hackage if you are using Stack? Once upon a time, it used to be built automatically after the package was uploaded, and if it wasn't, you could find out the reason why by checking the build logs. When that stopped working, I used a script called hackage-docs.sh that I got from somewhere. But now I've migrated from Cabal to Stack, and the old script no longer works. I can modify it to work with Stack, but is there a better way? Should I instead use the "delete documentation and trigger rebuild" button on Hackage? Here's the package in question: http://hackage.haskell.org/package/grid-7.8.7

That button does not help me. I tried to trigger doc–rebuild for a few
versions of `transient` package and docs are still unavailable (for latest
version I've uploaded docs manually).
*TL;DR:*
There is now *"Maintainer's Corner"* (it is located at the bottom of
package page and you'll see it if you're in maintainer group) where you can
find *"edit package information"* link. If you'll follow it you'll see
maintainer's page of package where you can find *"Manage
documentation"* section.
There goes a list of uploaded package version. Clicking on arbitrary
version will bring you to page with two forms, one for uploading docs and
another contains mentioned "*Delete documentation and trigger rebuild*"
button.
пт, 11 нояб. 2016 г. в 1:26, Sven Panne
2016-11-10 18:29 GMT+01:00 de Buitléir, Amy
: [...] Should I instead use the "delete documentation and trigger rebuild" button on Hackage? [...]
Huh? To be honest, I've never seen such a button. Where is it exactly? Is it something added recently?
Cheers, S. _______________________________________________ Haskell-Cafe mailing list To (un)subscribe, modify options or view archives go to: http://mail.haskell.org/cgi-bin/mailman/listinfo/haskell-cafe Only members subscribed via the mailman list are allowed to post.

2016-11-10 22:47 GMT+01:00 Geraldus
[...] There is now *"Maintainer's Corner"* (it is located at the bottom of package page and you'll see it if you're in maintainer group) where you can find *"edit package information"* link. If you'll follow it you'll see maintainer's page of package where you can find *"Manage documentation"* section. There goes a list of uploaded package version. Clicking on arbitrary version will bring you to page with two forms, one for uploading docs and another contains mentioned "*Delete documentation and trigger rebuild*" button. [...]
o_O Very well hidden, thanks for the hint, I think I would have *never* found that...

Hi!
Stack doesn't currently support uploading haddocks. There's an open issue
to add such a feature though, in case anyone is interested in fixing the
situation: https://github.com/commercialhaskell/stack/issues/737.
AFAIK the neil tool (https://github.com/ndmitchell/neil) supports uploading
haddocks, but I don't know how it plays with stack.
Hope that helps,
Simon
2016-11-10 18:29 GMT+01:00 de Buitléir, Amy
A package I uploaded to Hackage a week ago still has no docs. (It says "Docs pending" and "Build status unknown".) What is the best way to get Haddock documentation for a package onto Hackage if you are using Stack?
Once upon a time, it used to be built automatically after the package was uploaded, and if it wasn't, you could find out the reason why by checking the build logs. When that stopped working, I used a script called hackage-docs.sh that I got from somewhere.
But now I've migrated from Cabal to Stack, and the old script no longer works. I can modify it to work with Stack, but is there a better way? Should I instead use the "delete documentation and trigger rebuild" button on Hackage?
Here's the package in question: http://hackage.haskell.org/pac kage/grid-7.8.7 _______________________________________________ Haskell-Cafe mailing list To (un)subscribe, modify options or view archives go to: http://mail.haskell.org/cgi-bin/mailman/listinfo/haskell-cafe Only members subscribed via the mailman list are allowed to post.

OK, I've modified the hackage-docs.sh script to work with Stack. In case anyone else wants it, it's at https://github.com/mhwombat/stack-haddock-upload.

On 11/10/16 9:29 AM, de Buitléir, Amy wrote:
But now I've migrated from Cabal to Stack, and the old script no longer works. I can modify it to work with Stack, but is there a better way?
My guess would be to use Stack to set up your environment, and then do something like "stack exec -- cabal upload --documentation", but I haven't tried that.
Should I instead use the "delete documentation and trigger rebuild" button on Hackage?
I tried that button when I was having trouble with documentation, and it didn't work for me.
Here's the package in question: http://hackage.haskell.org/package/grid-7.8.7
If you (or anyone else out there) would like me to upload docs for you, I'd be happy to do so. Just add me to your package's maintainer group. I've already done this for the SFML package: https://github.com/SFML-haskell/SFML/issues/7 and I'd be happy to do it with other packages, at least until I get swamped with requests. I think having up-to-date documentation on Hackage is really important, and I'm happy to help out to achieve this goal. --Patrick
participants (5)
-
de Buitléir, Amy
-
Geraldus
-
Patrick Pelletier
-
Simon Jakobi
-
Sven Panne