如何使用Cabal生成Haddock文档？本地文档生成问题求助

我来帮你搞定用Cabal生成本地文档的事儿，针对你遇到的情况，分步骤给你捋清楚：

一、在cabal install gtk3时同步生成文档的正确配置 #

首先你提到在.config里加了-- documentation: True，这里可能是配置格式出问题了——Cabal的配置文件里不需要前面的--，正确的写法应该是：

documentation: True

修改完配置后，你可以先执行cabal config list，找到documentation那一行，确认它的值是True，确保配置生效。

之后执行安装命令时，保险起见可以显式加上启用文档的参数，避免全局配置没生效的情况：

cabal install gtk3 --enable-documentation

文档生成后的位置 #

如果是用户本地安装（Cabal默认的--user模式），文档会存在你的用户目录下，路径大概是：

~/.cabal/share/doc/<平台架构>-ghc-<GHC版本>/gtk3-<包版本>/

比如~/.cabal/share/doc/x86_64-linux-ghc-9.4.8/gtk3-0.15.8/，进去就能看到HTML格式的文档了。

二、单独本地生成文档的通用方法 #

如果上面的方式还是没生成文档，或者你想给已安装的包补生成文档，可以用cabal haddock命令：

• 针对单个包（比如gtk3）：

  cabal haddock gtk3
  

• 如果要生成Hoogle索引方便搜索，可以加参数：

  cabal haddock gtk3 --haddock-hoogle
  

• 要是你在本地项目目录下，想给项目生成文档，直接执行：

  cabal haddock
  

生成的文档位置和上面的路径一致，都是用户目录下的.cabal/share/doc里。

三、关于本地用户安装的警告 #

你提到Cabal仅执行本地用户安装且出现警告，这其实是Cabal的默认行为——它默认用--user模式安装到用户专属目录，避免修改系统级文件（需要root权限）。这类警告一般只是提示你安装路径在用户目录，不是错误，不用太担心。

如果你确实需要系统级安装，就加上--global参数，但不推荐这么做，因为容易和系统包管理工具（比如apt、yum）的包冲突。

内容的提问来源于stack exchange，提问作者Friedrich