search

z0w0 / helm

A functionally reactive game engine, with headgear to protect you from the headache of game development provided.
http://helm-engine.org/
MIT License
600 stars 69 forks source link

Documentation did not get uploaded to hackage #43

Closed funrep closed 10 years ago

funrep commented 10 years ago

http://hackage.haskell.org/package/helm-0.5.0/docs/FRP-Helm.html

I guess you forgot to build the haddock documentation. :P Just made this issue in case you missed it.

z0w0 commented 10 years ago

Wait, so did the new hackage get rid of the automatic bot that does it? Because that's how it used to work.

funrep commented 10 years ago

Oh they did, I'm not sure. I uploaded the package verbalexpressions recently and it did not generate any docs automatically, I just thought I was supposed to build it manually before compiling the package. It might be a bug? I've not yet tried my hypothesis.

z0w0 commented 10 years ago

Doesn't look like the bot has hit it yet so I'm going to upload it manually later tonight. Can't find any documentation on how to do that or why they got rid of the bot which is great.

AphonicChaos commented 10 years ago

If you check the hackage documentation's notes section [1], it states specifically that the source package must include the documentation. Whether or not this is a recent change, I don't know (I'm new to haskell myself), but this at least explains why they aren't being built automatically. As for how, it seems the wiki comes in handy [2]

[1] http://hackage.haskell.org/upload (third bulllet point) [2] http://www.haskell.org/haskellwiki/How_to_write_a_Haskell_program#Build_some_haddock_documentation

z0w0 commented 10 years ago

The automated bots definitely still exist, the issue is for some reason when building it for Helm (and misc. other projects) it generates garbage for the docs containing such things as incomplete documentation of dependencies.

AphonicChaos commented 10 years ago

Ah. Well that's odd

z0w0 commented 10 years ago

I have a feeling this is something to do with the glib bindings because whenever I try to generate the documentation locally (with hyperlinking between projects enabled), it hits an issue with building the glib documentation. The sooner we can get away from the cairo dependency the better. Only issue is that Pango also has a dependency on glib and Pango's text rendering is awesome :(

z0w0 commented 10 years ago

It's there now.