Как встраивать изображения в документацию Haddock

Question

Как я могу встраивать изображения в местную документацию Haddock?

Я вижу, например, lens Пакет просто использует внешние ссылки на изображения, но я хотел бы хранить изображения локально.

(Этот вопрос очень похож на (без ответа) вопрос в списке рассылки).

Answer 1

Если вы хотите сохранить свое изображение локально, вы можете:

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

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

Результат:

Если вы не хотите или не можете добавить изображение по относительному пути, просто введите имя изображения без полного пути:

<<your_image.png>>

В этом случае ваше изображение должно быть в project/docs каталог.

Answer 2

Как объясняется в той ветке списка рассылки, на которую вы ссылаетесь, один из вариантов - использовать URL-адрес данных для вставки изображений в вашу документацию. Это делает сам источник несколько неприятным для чтения (так как он перемежается с большими каплями данных в кодировке base64), хотя использование именованных фрагментов Haddock может помочь, помещая все изображения в именованные фрагменты в конце файла. Для реального примера такого подхода см. Документацию Haddock для пакета круговой упаковки.

Answer 3

Как объяснил в своем блоге Иан Росс, вы можете использовать extra-doc-files опция cabal для добавления дополнительных файлов в документацию.