为带有堆栈的测试模块生成haddock

时间:2018-09-11 14:38:06

标签: haskell haskell-stack haddock

有什么方法(使用stack)为测试模块生成Haddock文档吗?

命令:

stack haddock

将为库模块生成文档。我尝试使用haddock-arguments更改一些command line options,但没有成功。

即使stack不支持此功能,我也愿意接受其他选择。

1 个答案:

答案 0 :(得分:1)

stack exec -- haddock test/**/*.hs -odocs -h

我使用堆栈1.7.1和haddock 2.20.0进行了测试。

目前尚不清楚您所使用的平台;可以在Linux上的zsh上运行。该原则应在其他平台上起作用。它在.hs目录中的所有test文件上运行haddock,并将html输出(-h)放在docs目录中(如有必要,它会创建)。似乎会覆盖其中的任何内容。

您可能也希望在stack issue tracker上提出功能请求。这是一个很好的建议!并且结果命令将包含正确的依赖项链接,而无需您自己提供它们。

最后,Cabal带有其new-build选项,显然可以做到这一点(我尚未测试过)。 haddock-tests: True选项将进入cabal.project文件中。