Haddockとスタックを使用して私自身のコードのドキュメントを生成する

Question

私はHaddockスタイルで自分のコードに注釈を付け、閲覧可能なドキュメントを生成したいと思います。私もスタックを使用しているので、ドキュメンテーション生成をワークフローに統合したいと思っています。しかし、私はまだ何か有用なものを生み出すことはできませんでした。

私は

stack haddock 

実行することができ、それは私が望むスタイルでドキュメントを生成します（深い~/.stack/の中に発見される）、それだけのためではなく、私が依存するパッケージのドキュメントを生成しているようです私自身のコード。

私は

stack haddock --help 

を実行すると、私は私が私の依存関係のドキュメントを残すために私自身のプロジェクトのドキュメントを生成するために追加の引数--haddockを使用して、--no-haddock-depsできる印象を受けます。しかし、私が走るとき

stack haddock --haddock --no-haddock-deps 

何も起こっていないようです。もし私が最初にstack cleanと入力すると、すべてのコードが再コンパイルされますが、出力は生成されずにドキュメントに関連するように見えます。私はまた、それ自体でハドックを実行しようとしている中間液として

すなわち

haddock my-source.hs 

その後私はそれをファイル（スタックによってローカルにインストールされる）に依存するモジュールを見つけることができないというエラーを取得します。これは、ドキュメンテーションの生成が何とかスタックを経由しなければならないという印象を与えてくれます。私が探したが、実際のドキュメントのための私の.cabalとstack.yamlファイルの構成に関連する説明を発見していません。

TL; DR

がどのように私は自分のパッケージにコードのドキュメントを生成するために、スタックとハドックを使用することができますか？

Answer 1

スタック課題追跡にthis ticketによると、スタックは、現在唯一の実行可能ファイルをライブラリのドキュメントを構築することはできませんが。

陰謀団は、このコマンドを使用して、スタックのデータベースと連動するように設定することができます。

​​

た後、あなたがドキュメントを生成するためにcabal haddock --executablesを実行することができます。

ちなみに、stack haddockはstack build --haddockのショートカットなので、stack haddock --haddockを書く必要はありません。

Answer 2

https://www.reddit.com/r/haskell/comments/5ugm9s/how_to_generate_haddock_docs_for_nonlibrary_code/ddtwqzc/

個々のファイルが指定されている場合は、次のソリューションは、動作します：

stack exec -- haddock --html src/Example.hs src/Main.hs --hyperlinked-source --odir=dist/docs