Есть ли у кого-нибудь опыт внедрения изображений внутри локальной Haddock документации?
Я вижу, например, пакет lens использует внешние ссылки для изображений, но я хотел бы хранить изображения локально. Я бы хотел найти самое лучшее решение "лучшей практики", так как я разработал пару хаков, но ничего не понял.
(Этот вопрос очень похож на (неотвеченный) вопрос в списке рассылки).
Если вы хотите сохранить свое изображение локально, вы можете:
-- A longer description of the package.
description: Some haskell package description.
<<file:///home/user/your_image.png>>
Результат:
Если вы не хотите или не можете добавить изображение по относительному пути, просто введите имя изображения без полного пути:
<<your_image.png>>
В этом случае ваше изображение должно находиться в каталоге project/docs.
Как объясняется в этом потоке списка рассылки, который вы ссылаетесь, одним из вариантов является использование URL-адреса данных для встроенных изображений в вашу документацию. Это делает сам источник несколько неприятным для чтения (поскольку он чередуется с большими блоками данных с кодировкой base64), хотя использование Haddock названных фрагментов может помочь, поставив все изображения в именованных фрагментах в конце файла. Для реального примера такого подхода см. Документацию Haddock для пакета упаковки кругов.
Как объяснено в в блоге Ian Ross, вы можете использовать опцию extra-doc-files cabal для добавления дополнительных файлов в документацию.