上传包到hackages时没有生成haddock

时间:2012-04-29 04:34:52

标签: haskell cabal hackage

我将我的包上传到hackages后,它没有像其他包那样生成haddock。

我错过了什么?

我做的是:

  1. cabal dist以及在dist目录下生成的包。
  2. 打开hackage web upload界面并上传包。
  3. 打开URL,结果已成功上传包但没有黑线鳕。 (该软件包确实有一些文档)
  4. 谢谢。

3 个答案:

答案 0 :(得分:6)

Docs花费一点时间来生成。我相信它们是在格林威治标准时间午夜时分运行的。

答案 1 :(得分:1)

除了Thomas的回答之外,在您的包目录中运行cabal haddock并查找任何错误。

Haddock在我的经历中非常挑剔,特别是wrt。代码块。如果出现解析错误,只需开始删除注释,直到可以生成文档。我通常使用一些广泛记录的包作为参考。

答案 2 :(得分:0)

看起来文档丢失了,因为你的包没有正确构建。我发现这接近build log

的末尾
src/Network/OAuth2/HTTP/HttpClient.hs:18:8:
    Could not find module `Control.Monad.Trans.Resource'
    It is a member of the hidden package `resourcet-0.3.2.1'.
    Perhaps you need to add `resourcet' to the build-depends in your .cabal file.
    Use -v to see a list of the files searched for.

要避免出现这些问题,请确保在上传之前使用Cabal 在本地构建 。直接使用GHC构建通常会掩盖这些类型的问题,因为无论您是否在.cabal文件中提及它们,它都会愉快地使用您安装的任何软件包。