如何在本地生成我的cabal包的网页预览?

时间:2011-12-06 09:46:22

标签: haskell cabal

来自Hackage check/upload页面:

  

检查Cabal包

     

不允许重新上传具有相同版本号的软件包,因此您可能需要在上传之前进行一些检查:

     
      
  • 您可以检查您的源包是否构建,包括haddock文档(如果它是库)。
  •   
  • 以下表单检查包是否可上传,警告其他各种事项,显示包的网页预览。它不会将包添加到数据库中。
  •   

(我的重点)

如何在本地生成包的网页预览?即不使用该网站表格?

(“套餐的网页”是例如this is QuickCheck's。)

1 个答案:

答案 0 :(得分:3)

您使用cabal haddock生成此页面。这将生成dist/doc/html/<library-or-executable-name>/index.html中的文档。

此外,您可以编辑~/.cabal/config文件以包含以下行:

documentation: True

这将自动安装您使用Cabal安装的所有软件包的文档,您将在~/.cabal/share/doc/index.html文件中获得系统上所有已安装模块的列表。这对于ghci会话或者当您想要找出哪个包包含哪些模块等时非常有用