haskell - Haddock ドキュメントに画像を埋め込む方法

Question

ローカルのHaddockドキュメント内に画像を埋め込むにはどうすればよいですか?

たとえば、lensパッケージは画像への外部リンクを使用しているだけですが、画像をローカルに保存したいと思います。

(この質問は、メーリング リストの (未回答の) 質問と非常によく似ています)。

Answer 1

参照するメーリングリストスレッドで説明されているように、1つのオプションは、データURLを使用して画像をドキュメントにインライン化することです。ソース自体を読み取るのはやや不快になります（base64でエンコードされたデータの大きなブロブが散在しているため）が、Haddockの名前付きチャンクを使用すると、ファイルの最後にある名前付きチャンクにすべての画像を配置することで役立ちます。このアプローチの実際の例については、サークルパッキングパッケージのHaddockドキュメントを参照してください。

Answer 2

イメージをローカルに保存する場合は、次のことができます。

-- A longer description of the package.
description: Some haskell package description.

    <<file:///home/user/your_image.png>>

結果：

相対パスで画像を追加したくない、または追加できない場合は、フルパスなしで画像名を入力してください:

<<your_image.png>>

この場合、イメージはproject/docsディレクトリにある必要があります。

Answer 3

Ian Ross のブログ投稿で説明されているように、extra-doc-files追加のファイルをドキュメントにバンドルするために cabal オプションを使用できます。