如何使用Cabal生成Haddock？

Question

我迷路了。我不知道如何使用cabal在本地生成文档。我想要的是cabal安装gtk3，这也生成了文档。或者，如果这不起作用，我如何在本地生成文档？

我已经将它从cabal：-- documentation: True放到了我的.config文件中

但是没有好的结局，找不到文档

我想这是一件很简单的事情，我根本看不到...

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

如果我没有使用它，我就会得到关于全局不应该使用的警告，即使是文档集也不能使用文档:真的，我得不到haskell平台文档的更新。

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

Answer 1

我相信您正在寻找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

Answer 2

我花了一些时间，这里的一些帖子给我指明了正确的方向。

一开始，是我的错。我确实在documentation下用True替换了False，但没有取消对该行的注释，所以默认情况下不会生成文档(我不认为这是一个好的默认值- YMMV)

那么cabal确实在本地正常工作，有一个标志--global来更改它，或者您可以在~/.cabal/config中更改int

现在文档发生了什么，如下所示。文档是在主目录中生成的，但所有文档都链接到新生成的index.html文件中。因此，您可以从全局安装和本地安装中获取文档。

现在我还是搞不懂一些东西。我不知道为什么阴谋不应该是全球使用安装所有的文件到一个全球的位置。

是的，我偶然发现了堆栈、沙箱和新的-xxxx(命令)，我仍然不知道该如何理解它们……但我想这是另一个问题了。