2017-03-23 38 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