問題タブ [haddock]

tarball ソースから haddock-2.4.2 をコンパイルしてインストールしました。

ここのコードにいくつかの簡単なコメントを追加します。

• https://dl.getdropbox.com/u/143480/doc/DualMap.hs

ハドックを実行しています

収量:

• https://dl.getdropbox.com/u/143480/doc/Data-DualMap.html

物事は良さそうです。(このモジュールは、GHC に同梱されているライブラリにのみ依存し、他のソース モジュールには依存しないことに注意してください。)

ただし、「-- * test」を使用してコメントにセクション (a la http://www.haskell.org/haddock/doc/html/ch03s04.html#id289234 ) を追加しようとすると、次のようになります。

このエラー メッセージは Haddock.Interface.depanal が (hadock ソースの grep によると) Nothing を返したことだけを示しており、依存関係の分析が失敗するのを止める方法は示していないため、これを機能させるにはどこから始めればよいかわかりません。おそらく、GHC/base/containers のドキュメントや Haddock の設定ファイルで不足しているリンク先へのコマンド ライン引数や参照が必要でしょうか?

Google を検索すると、ハックのパッケージについて同じ同類の多数の cabal ビルド エラーが得られましたが、それらを修正する方法については何もありませんでした。

セクション (アスタリスク付き) を追加し、Haddock にドキュメントを生成させるにはどうすればよいですか? 私が見逃しているもの (おそらく単純なもの) は何ですか?

私は GHC を使用しており、Cabal 経由でいくつかのパッケージをインストールしました。パッケージの Web サイトの 1 つには、「haddock のドキュメントを参照してください」と書かれています。このhaddockコマンドはソース ファイルでのみ機能するようで、ビルド ファイルcabal haddockを含むプロジェクトの最上位ディレクトリでのみ機能するようです。.cabalモジュールに対して「ハドックを見せて」と言う方法はありますか?

私はpydoc -p 12345、ローカルにインストールしたものに基づいて Python ドキュメントを提供する HTTP サーバーを開始することを待ち望んでいます。

回避策として、ソース tarball を下から抽出し、ソース ディレクトリで~/.cabal実行しましたが、それはちょっと面倒です。cabal configure; cabal haddock

このコマンドcabal haddockには、非常に便利な--hyperlink-sourceオプションがあります。を使用してドキュメントを作成するときに、ソースをハイパーリンクしたいと思いますcabal install。

チケット＃517はそれについてのようです：http：//hackage.haskell.org/trac/hackage/ticket/517

ただし、おそらく〜/ .cabal / configファイルを介してこのフラグを設定することは可能ですか？

そうでない場合、現在必須であるCabal-1.9をインストールせずに＃517のパッチを使用してcabal-installビルドを機能させるにはどうすればよいですか（12月のパッチが1つあるため）。

現時点ではHaddockのみを使用していますが、読み書きのできるHaskellの非常に興味深い例（この要点など）をいくつか見た後、プロジェクトで試してみることに興味があります。

私が得た質問は次のとおりです。

• あなたはハドックのコメントとして何を書きますか、そしてあなたは読み書きのできる部分に何を書きますか？

• 文芸的プログラミングを複数のファイルにどのようにスケーリングしますか？複数のモジュールを含むパッケージで文芸的プログラミングが使用されている例を誰かに教えてもらえますか？より大きなパッケージで文芸的プログラミングを使用した経験は何ですか？

• 読み書きのできるHaskellのどのフレーバー（マークダウン、ラテックスなど）が好ましいですか？

• なぜあなたは読み書きのできるHaskellやプレーンなバニラHaskellでプログラミングしているのですか？両方のスタイルでプログラミングしていますか？もしそうなら、なぜですか？

• \begin{code}ブロックスタイル（ ）とバードスタイル（）のどちらが好き>ですか？なんで？

私は次の機能を持っています：

Haddockは上記を取得し、次のHTMLを生成します。

「アルファ」はどうなりましたか？

もし私がラインを得たら

.cabal-file のドキュメント部分 (説明) にエラー メッセージが表示されます

実行中

しかし、を取り除くと、{すべて}が正常に機能します。{}説明で使用できるようにエスケープする方法はありますか?

ハドックで生成されたドキュメントを含むパッケージがHackageにありますが、Hackageページに表示されません。すべてを正常にアップロードできますが、ドキュメントが表示されません。

LeksahIDEを使用してcabal haddockまたはでドキュメントを生成します。Package > Build Documentation

Leksahに行くとPackage > Open Doc、探しているので見つかりませんdist/doc/html/hspec/hspec/index.htmlが、生成されたファイルはにありdist/doc/html/hspec/index.htmlます。ハッカゲも同じ場所を見ていると思います。

ソースファイルが期待した場所にないのではないかと思いますが、他にどうあるべきかわかりません。

ソースとディレクトリの構造はhttps://github.com/trystan/hspecにあります。

次のモジュールを検討してください

このモジュールは、ファーストクラスモジュールのように機能FirstClassModuleするレコードタイプを提供することを目的としています。Bar次に、モジュールはモジュールExampleをインスタンス化し、RecordWildCards拡張機能を使用して名前をスコープに取り込み、エクスポート可能にします。

このモジュールでHaddock（バージョン2.8）を実行すると、foo関数の型シグネチャが干渉され、APIドキュメントに含まれます。さて、私の質問は：

モジュールに型署名を書き留めずfooに、結果の名前fuhなどを文書化する方法はありますか？Example

この場合は定型文であるため、型アノテーションは書きたくありません。それらを書き留める必要がある場合、このモジュールはその存在理由を失います。

Hoogleをローカルで使用したいので、プロジェクトの1つで検索クエリを実行できます。[ここ]にいくつかのドキュメントがありますが、それを機能させる方法がわかりません。Haddockを実行するように指示されていますが、haddockは出力を提供せず、以下にコピーされた警告を吐き出すだけです。projectname.cabalファイルがまだないので、コマンドを使用できませんrunhaskell Setup haddock --hoogle。

javadocと同じように、ハドックのドキュメントをフォーマットしたいと思います。たとえば、HTMLやその他のマークアップを挿入して、JavaScriptやCSSを除外せずに、よりクリーンな出力を取得できるようにします。特に、行を挿入する方法を知りたいです。ドキュメントを壊します。

ありがとう！