2009-10-19 49 views
10

我使用GHC並通過Cabal安裝了幾個軟件包。其中一個軟件包的網站上說:「去看看黑道文件」。 haddock命令似乎只適用於源文件,並且cabal haddock似乎只能在具有.cabal構建文件的項目的頂級目錄中工作。有沒有辦法對一個模塊說「給我展示黑線鱈」?用於Cabal-mounted模塊的黑度?

我很期待pydoc -p 12345,它啓動一個HTTP服務器,根據您在本地安裝的內容提供Python文檔。

作爲解決方法,我從源代碼目錄中提取了~/.cabal之下的源代碼tarball,並運行了cabal configure; cabal haddock,但這很痛苦。

回答

19

編輯您的配置文件:

〜/ .cabal /配置

有一個選項來啓用默認安裝DOC:

文檔:真

要安裝現有軟件包的doc,請使用:

小集團安裝XXX --reinstall

重新安裝從基本包然後上層包,因此,「超鏈接」到其它模塊的文檔將被適當地生成。

3

這是一個known issue。作爲一種解決方法,您可以使用this small PHP script來配置您的Apache安裝(如果有的話)爲您的doc目錄提供服務。

+0

@Martjin:關於那個鏈接,hackage.haskell.org是否適合你?從這裏看,它最近兩天看起來很糟糕,並且http://downforeveryoneorjustme.com/hackage.haskell.org確認.. – yairchu 2009-10-19 14:48:37

+0

謝謝,你在那篇文章中的筆記也讓我改變了我的.cabal/config來生成文檔默認情況下。 – 2009-10-19 19:43:35

+0

Hackage現在應該備份。 :-)是的,它停了一會兒。人們也在Haskell咖啡館詢問這件事。 – Martijn 2009-10-21 11:53:48

3

你應該能夠產生本地文檔:

cabal install $project --haddock 

假設你已經安裝了鱈魚。

+1

謝謝 - 在另一個答案中的hackage鏈接將我引向同一個標誌。然後我更新了我的.cabal/config文件以使其成爲默認值。現在(在OS X上)我可以說「open〜/ .cabal/share/doc/$ project - */html/index.html」,並在我的瀏覽器中彈出文檔。如果index.html文件不存在,我已經寫了一個bash函數來爲項目名稱執行此操作,或者輸出錯誤消息。 – 2009-10-20 19:38:24

7

--haddock國旗不適合我。然而,隨着--enable-documentation更換--haddock也:

cabal install $project --enable-documentation 

現在,如果他們能允許--hyperlink-source標誌壓縮通過對黑線鱈,我會很高興。