Haddock für Cabal-Module installiert?
Frage
Ich bin mit GHC und haben mehrere Pakete über Cabal installiert. Einer der Web-Site -Pakete sagt ‚gehen, um die Schellfisch-Dokumentation‘. Der haddock
Befehl scheint nur die Arbeit an Quelldateien und cabal haddock
scheint nur an der Arbeit in dem Top-Level-Verzeichnis eines Projektes mit einer .cabal
Build-Datei. Gibt es eine Möglichkeit „zeigen Sie mir das Schellfisch“ für ein Modul zu sagen?
Ich bin die Sehnsucht nach pydoc -p 12345
die beginnt, einen HTTP-Server bietet Python-Dokumentation auf, was Sie lokal installiert haben.
Als Behelfslösung, extrahierte ich den Quell-Tarball unter ~/.cabal
und RAN cabal configure; cabal haddock
im Quellverzeichnis, aber das ist eine Art Schmerz.
Lösung
bearbeiten Ihre Konfigurationsdatei:
~ / .cabal / config
gibt es eine Option standardmäßig aktivieren doc installieren:
Dokumentation: Wahr
doc bestehende Pakete zu installieren, zu verwenden:
Cabal installieren xxx --reinstall
re-installieren docs von Basispaketen dann die höherrangige Pakete, so dass die „hyper-link“ zu anderen Modulen ordnungsgemäß erzeugt werden.
Andere Tipps
Die --haddock
Flagge nicht für mich arbeiten. Allerdings ersetzt --haddock
mit --enable-documentation
tat:
cabal install $project --enable-documentation
Nun, wenn sie die --hyperlink-source
Flagge Reißverschluss ermöglichen könnte durch ich haddock würde sehr glücklich sein.
Dies ist ein bekanntes Problem . Zur Umgehung des Problems können Sie Ihre Apache-Installation konfigurieren (falls Sie eine haben) Ihr doc Verzeichnis mit dieser kleine PHP-Skript .
Sie sollten in der Lage sein, lokale Dokumentation zu erzeugen, mit:
cabal install $project --haddock
Angenommen, Sie haben Haddock installiert.