2017-03-23 37 views
0

我使用不会对Stackage文档(他们是过时的)项目。原来这里是一个这是对VERSON 0.3如何用haddock生成文档?

https://hackage.haskell.org/package/reflex-dom-0.3/docs/Reflex-Dom-Widget-Basic.html

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

haddock网页太高级了。

对于初学者来说,一旦我在我的目录,我怎么生成的文档?


多亏了答案,我提出来的进步,但这里的一个是错误消息:

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

这并不完全清楚是什么问题。你不知道如何生成文档作为网页?或者你有一个问题如何安装它?或者你有关于haddock特定功能的问题? –

+0

@ git clone'后的@WillemVanOnsem我在shell中输入什么来生成文档? –

回答

2

一旦安装haddock,您可以按以下运行

haddock --html -o the_documentation *.hs 

将产生在该目录下所有的Haskell文件的文件(不是任何子目录)在名为the_documentation的目录中。

一些shell允许**.hs寻找全部.hs文件(包括子目录)。所以,你可以尝试:

haddock --html -o the_documentation **.hs 

如果shell就不能支持,当然你可以使用的findxargs组合,如:

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

这里find将生成的所有文件的列表为此有.hs,并xargs会写所有这些文件作为参数传递给haddock --html ...

+0

是的,我正要说...我的Haskell文件如何被埋藏在不同深度的'* .hs'文件中。 '找。 -name“* .hs”'哦,你得到了! –

+0

你能告诉'haddock'跳过haddock不起作用的文件吗? –

+0

@johnmangual:你能指定哪些文件无法工作吗? –

1

cabal haddockstack haddock。因此,例如

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

+0

保存的文件在哪里? –

+1

@johnmangual至少对于'栈haddock',栈将运行后'堆栈haddock'告诉你的文档保存。 – Alec