Haddock スタイルでコードに注釈を付けて、ブラウズ可能なドキュメントを生成したいと考えています。私もスタックを使っているので、ドキュメント生成をワークフローに統合したいです。ただし、まだ有用なものを生成できていません。
走れる
stack haddock
そして、それは私が望むスタイルでドキュメントを生成します ( の奥深くにあります~/.stack/) が、自分のコードではなく、依存しているパッケージのドキュメントのみを生成するようです。
私が走るとき
stack haddock --help
--haddock追加の引数を使用して、自分のプロジェクトのドキュメントを生成--no-haddock-depsし、依存関係のドキュメントを省略できるという印象を受けました。ただし、実行すると
stack haddock --haddock --no-haddock-deps
何も起こらないようです。最初にstack cleanすべてのコードを再コンパイルすると、ドキュメントに何らかの形で関連しているように見える出力が生成されません。
中間的な解決策として、Haddock を単独で実行してみました。つまり、
haddock my-source.hs
しかし、ファイルが依存するモジュールが見つからないというエラーが表示されます(スタックによってローカルにインストールされます)。これは、ドキュメントの生成が何らかの方法でスタックを通過する必要があるという印象を与えます。.cabal私は探しましたが、ドキュメント用の myおよびstack.yamlfiles の構成に関連する説明は実際には見つかりませんでした。
TL;DR
スタックと Haddock を使用して、自分のパッケージ内のコードのドキュメントを生成するにはどうすればよいですか?