使用cabal生成文档

时间:2018-04-03 16:37:20

标签: haskell cabal haddock

我输了。我不知道如何使用cabal在本地生成docs。我想要的是cabal安装gtk3,它确实生成了文档。或者,如果这不起作用,我如何在本地生成文档?

我已将它放入cabal的.config文件中: - 文件:真实

但是没有好的结局,没有找到文件

我想这很简单,我根本就没有看到......

好的,在一些评论的帮助下,我得到了更多。无论如何cabal只是为我做本地安装作为用户,它给了我一个警告,不建议全局。在这里,我找到了https://wiki.haskell.org/Cabal-Install

我应该为全球安装等做什么,但是如果我没有使用它,我会收到有关全局不应该被使用的警告,即使是文档集也要做文档:我是真的没有得到haskell平台文档的更新。

所以我不应该使用cabal进行全局文件安装?

2 个答案:

答案 0 :(得分:5)

我相信您正在寻找cabal haddock或者您正在使用新命令cabal new-haddock。观察:

% cabal unpack gps
Unpacking to gps-1.2/
% cd gps-1.2
% cabal --help | grep document
  upload           Uploads source packages or documentation to Hackage.
  haddock          Generate Haddock HTML documentation.
  new-haddock      Build Haddock documentation
% cabal haddock
Resolving dependencies...
Configuring gps-1.2...
Preprocessing library for gps-1.2..
Running Haddock on library for gps-1.2..
... snip ...
Documentation created: dist/doc/html/gps/index.html
cabal haddock  3.42s user 1.00s system 92% cpu 4.784 total

答案 1 :(得分:0)

嗯我花了一些时间,这里的一些帖子指出了我正确的方向。

起初,我的错。我在文档中用True替换了False但没有取消注释该行,因此默认发生的是不生成文档(不能将此视为一个好的默认值 - YMMV)

然后cabal在本地正常工作,有一个标志--global来改变它,或者你可以在〜/ .cabal / config中改变int

现在文档会发生以下情况。文档在主目录中生成,但所有文档都链接到新的genarated index.html文件中。因此,您可以从全局安装和本地安装中获取文档。

现在我还没有得到一些东西。我'不知道为什么cabal不应该全球用于将所有fille安装到全球位置。

是的,我偶然发现堆栈,沙箱和新的xxxx(命令)我仍然不知道如何用它们做出来......但这是我猜的另一个问题。