yesodweb / yesod

A RESTful Haskell web framework built on WAI.
http://www.yesodweb.com/
MIT License
2.63k stars 372 forks source link

Haddock document is missing for recent releases on Hackage. #887

Closed YongJoonJoe closed 9 years ago

YongJoonJoe commented 9 years ago

For recent releases, I couldn't find any haddock reference of Yesod on Hackage. I thought that there are no more updates for these documents. Today, I finally found that haddock references on Stackage when I do something other.

Is there any problem with generating or uploading haddock references to Hackage side? I think that updating this documents in Hackage is very important. Almost every users would refer to Hackage's one more than Stackage's.

snoyberg commented 9 years ago

This is a Hackage bug. There's no reliability to the documentation building process there, and no end user control to help make it succeed.

YongJoonJoe commented 9 years ago

I didn't know that Hackage bug. I'm sorry and thanks for your reply.

gregwebs commented 9 years ago

We can upload our own documentation though. We should probably copy some code from the neil tool for that and put it in mega-sdist

snoyberg commented 9 years ago

For the record, my planned solution to this is simply to make the Stackage Server docs more easily available, and tell people to use those. I'm tired of trying to work around bugs in Hackage. If you want to modify mega-sdist, please feel free, but I'm not planning on modifying it or changing my workflow to account for Hackage instability.

gregwebs commented 9 years ago

One way or another it needs to be easy to look at the haddocks. We could also document how to do it locally.

snoyberg commented 9 years ago

For the record, all the docs are easily available on stackage. We're putting together a number of changes to improve layout- there are open issues for all those changes if you're curious- and then I believe there's no reason to tell people to look at the hackage pages.

On Sat, Dec 13, 2014, 11:37 PM Greg Weber notifications@github.com wrote:

One way or another it needs to be easy to look at the haddocks. We could also document how to do it locally.

— Reply to this email directly or view it on GitHub https://github.com/yesodweb/yesod/issues/887#issuecomment-66892530.

gregwebs commented 9 years ago

Do you want to put a link in the cabal description when it is ready?

snoyberg commented 9 years ago

That's a really good idea.

snoyberg commented 9 years ago

I've written a blog post about this, and started converting all my packages.

http://www.yesodweb.com/blog/2014/12/use-stackage-for-docs

ndmitchell commented 9 years ago

It took me under an hour to do, and the results are quite nice and it's only about 30 lines of code. If you do change your mind, I'm happy to point out the exact bits you will want to grab.

gregwebs commented 9 years ago

@ndmitchell said that the standard hoogle & hayoo will no longer be indexing these packages if they don't have docs on hackage. I think that is pretty bad. My sense is that there should be an easy way to do 1 of these 2 things:

ndmitchell commented 9 years ago

@gregwebs Hoogle uses whatever Hackage supplies, which I believe is the most recent around, not sure about Hayoo. If you do generate locally, make sure you generate with --hoogle so that it generates the Hoogle info as well, which you can load up.

Having an "import docs from Stackage to Hackage" would be a great feature, and might give people another reason to use Stackage as somewhere they have to go. Even better, if you could upload to Stackage and that uploaded to Hackage and doc uploaded to Hackage then I'd definitely drop neil docs for Stackage uploading...