使用堆栈为测试模块生成黑线鳕
Generating haddock for test modules with stack
是否有任何方法(使用 stack
)为测试模块生成 Haddock 文档?
命令:
stack haddock
将为库模块生成文档。我尝试使用 haddock-arguments
更改一些 command line options 但没有成功。
即使 stack
不支持这个,我也愿意接受其他选择。
stack exec -- haddock test/**/*.hs -odocs -h
我用堆栈 1.7.1 和黑线鳕 2.20.0 进行了测试。
不清楚你在哪个平台;这将适用于 linux 上的 zsh。该原理应该适用于其他平台。它在 test
目录中的所有 .hs
文件上运行黑线鳕,并将 html 输出 (-h
) 放在 docs
目录中(它创建,如果必要的)。它似乎覆盖了其中的任何内容。
您也可以在 stack issue tracker 上提出功能请求。 这是一个很好的建议!结果命令将包含正确的依赖关系链接,您无需自己提供它们。
最后,Cabal 及其 new-build
选项显然可以做到这一点(我还没有测试过)。 haddock-tests: True
选项将进入 cabal.project
文件。
是否有任何方法(使用 stack
)为测试模块生成 Haddock 文档?
命令:
stack haddock
将为库模块生成文档。我尝试使用 haddock-arguments
更改一些 command line options 但没有成功。
即使 stack
不支持这个,我也愿意接受其他选择。
stack exec -- haddock test/**/*.hs -odocs -h
我用堆栈 1.7.1 和黑线鳕 2.20.0 进行了测试。
不清楚你在哪个平台;这将适用于 linux 上的 zsh。该原理应该适用于其他平台。它在 test
目录中的所有 .hs
文件上运行黑线鳕,并将 html 输出 (-h
) 放在 docs
目录中(它创建,如果必要的)。它似乎覆盖了其中的任何内容。
您也可以在 stack issue tracker 上提出功能请求。 这是一个很好的建议!结果命令将包含正确的依赖关系链接,您无需自己提供它们。
最后,Cabal 及其 new-build
选项显然可以做到这一点(我还没有测试过)。 haddock-tests: True
选项将进入 cabal.project
文件。