haskell - 如何使用黑线鳕生成文档？

Question

我正在使用的项目在 Stackage 上没有文档（它们已经过时了）。这是 0.3 版的原始版本

有人告诉我我可以用黑线鳕生成文档。我的电脑上有源代码（使用git clone）版本 0.4

黑线鳕网页太先进了。

对于初学者，一旦进入我的目录，如何生成文档？

感谢我取得进展的答案之一，但这里有一条错误消息：

src/Reflex/Dom/Xhr.hs:154:0:
     error: missing binary operator before token "("
     #if MIN_VERSION_aeson(1,0,0)
     ^

score 5 · Accepted Answer

5

cabal haddock或stack haddock。

于 2017-03-23T19:07:49.463 回答

score 3 · Accepted Answer

安装haddock后，您可以按如下方式运行它：

haddock --html -o <haddock-folder> <list-of-haskell-files>

例如：

haddock --html -o the_documentation *.hs

将在名为the_documentation.

一些 shell 允许**.hs查找所有 .hs文件（包括子目录）。所以你可以试试：

haddock --html -o the_documentation **.hs

如果外壳不支持，您当然可以使用 and 的组合find，xargs例如：

find -iname '*.hs' | xargs haddock --html -o the_documentation

这里find将生成所有以 . 结尾的文件的列表.hs，xargs并将所有这些文件作为参数写入haddock --html ....

2 回答 2