Come posso inserire delle immagini nel documentazione locale Haddock?Come incorporare le immagini in Haddock documentazione
vedo per esempio the lens package utilizza solo collegamenti esterni alle immagini, ma mi piacerebbe per memorizzare le immagini in locale.
(Questa domanda è molto simile a an (unanswered) question on the mailing list).
Se si desidera memorizzare l'immagine in locale è possibile:
-- A longer description of the package.
description: Some haskell package description.
<<file:///home/user/your_image.png>>
Risultato:
Se non si vuole o non si può aggiungere l'immagine dal percorso relativo, basta mettere il nome immagine senza percorso completo:
<<your_image.png>>
In questo caso, l'immagine deve essere nella directory project/docs.
Come spiegato in quella discussione mailing list voi riferimento, una possibilità è quella di utilizzare un data URL inline immagini nella vostra documentazione. Rende la fonte stessa un po 'sgradevole da leggere (dal momento che è inframmezzato con grandi macchie di dati con codifica Base64), pur usando di named chunks Haddock può aiutare, mettendo tutte le immagini in blocchi chiamati alla fine del file. Per un esempio reale di questo approccio, vedere lo Haddock documentation for the circle-packing package.
È strano che non ti permetta di fare riferimento ai file di dati nel tuo pacchetto Cabal. o_o –
Non credo che Haddock sappia qualcosa su Cabal o anche su ghc-pkg, vero? – Dag
Il trucco dell'url di dati è abbastanza accurato. Questo potrebbe risolvere i problemi di prestazioni che otteniamo dal wiki in 'lens'. (Abbiamo cambiato i collegamenti nel file 'lens.cabal' per rimandare a' imgur', perché non ha problemi di disabilitazione della cache.) –
Come spiegato in a blog post by Ian Ross, è possibile utilizzare l'opzione extra-doc-files cabal per raggruppare file aggiuntivi nella documentazione.
non riesco a trovare un modo per incidere questo per ottenere un percorso relativo, anche se - quindi è fragile perché assume una directory in cui la documentazione verrà utilizzato sul disco di un utente. Destra? – amindfv
Sì, hai ragione. Se non riesci a ottenere un percorso relativo alle tue immagini, puoi anche aggiungere solo '' '<< Haskell-Logo-Variation.png >>' '' e che l'immagine di Haskell-Logo-Variation.png deve essere presente nel progetto directory doc. – 0xAX
Perfetto! È proprio quello che stavo cercando. Puoi aggiungerlo alla tua risposta? Nota anche che se la tua immagine è in, ad es. 'docs/images /', puoi fare riferimento a '<< images/some_img.jpg >>' – amindfv