Haddock用于Cabal安装的模块?

时间:2009-10-19 09:02:28

标签: haskell cabal haddock

我正在使用GHC并通过Cabal安装了几个软件包。其中一个软件包的网站上写着“去查看haddock文档”。 haddock命令似乎只适用于源文件,而cabal haddock似乎只能在具有.cabal构建文件的项目的顶级目录中工作。有没有办法为模块说“给我看看黑线鳕”?

我渴望pydoc -p 12345启动一个HTTP服务器,根据你在本地安装的内容提供Python文档。

作为解决方法,我从~/.cabal下提取源tarball并在源目录中运行cabal configure; cabal haddock,但这有点痛苦。

4 个答案:

答案 0 :(得分:19)

编辑您的配置文件:

  

〜/ .cabal /配置

可以选择启用默认安装文档:

  

文档:真实

要安装现有软件包的doc,请使用:

  

cabal install xxx --reinstall

从基本软件包重新安装文档,然后重新安装上层软件包,这样就可以正确生成其他模块的“超链接”。

答案 1 :(得分:7)

--haddock标志对我不起作用。但是,将--haddock替换为--enable-documentation会:

cabal install $project --enable-documentation

现在,如果他们可以让--hyperlink-source旗帜拉到黑线鳕,我会非常高兴。

答案 2 :(得分:3)

这是known issue。作为一种解决方法,您可以使用this small PHP script配置Apache安装(如果有)以便为您的doc目录提供服务。

答案 3 :(得分:3)

您应该能够使用以下方式生成本地文档:

cabal install $project --haddock

假设你安装了Haddock。