Haddock per i moduli Cabal-installati?
Domanda
Sto usando GHC ed ho installato diversi pacchetti tramite Cabal. Uno dei sito web i pacchetti dice: 'andare a vedere la documentazione eglefino'. Il comando haddock
sembra funzionare solo su file di origine, e cabal haddock
sembra funzionare solo nella directory di livello superiore di un progetto con un file .cabal
build. C'è un modo per dire "fammi vedere l'eglefino" per un modulo?
Sono desiderio di pydoc -p 12345
che inizia un server HTTP fornendo la documentazione Python in base a ciò che è stato installato in locale.
Come un work-around, ho estratto l'archivio dei sorgenti da sotto ~/.cabal
e corsi cabal configure; cabal haddock
nella directory di origine, ma questo è una specie di dolore.
Soluzione
modifica il file di configurazione:
~ / .cabal / config
c'è un opzione per abilitare di default l'installazione doc:
documentazione: True
per installare doc di pacchetti esistenti, usare:
cabala installare xxx --reinstall
reinstallare documenti da pacchetti di base quindi i pacchetti di livello superiore, in modo che il "iper-link" ad altri moduli sarà generato correttamente.
Altri suggerimenti
Il flag --haddock
non ha funzionato per me. Tuttavia, sostituendo --haddock
con --enable-documentation
fatto:
cabal install $project --enable-documentation
Ora, se potevano permettere la bandiera --hyperlink-source
a zip fino al eglefino sarei molto felice.
Questa è una problema noto . Come soluzione alternativa è possibile configurare l'installazione di Apache (se ne avete uno) per servire la vostra directory doc utilizzando questo piccolo script PHP .
Si dovrebbe essere in grado di generare la documentazione locale con:
cabal install $project --haddock
Supponendo di avere installato Haddock.