Erzeugen von Dokumentation für meinen eigenen Code mit Haddock und Stack

Question

Ich habe meinen Code im Haddock-Stil kommentiert und würde gerne durchsuchbare Dokumentation erstellen. Da ich auch Stack verwende, möchte ich die Dokumentationsgeneration in den Workflow integrieren. Ich konnte jedoch noch nichts Nützliches generieren.

ich laufen kann

stack haddock 

und es wird erzeugen Dokumentation im Stil ich will (zu tief in ~/.stack/ zu finden), aber es scheint nur Dokumentation ich davon ab, für die Pakete zu erzeugen, anstatt für mein eigener Code.

Als ich

stack haddock --help 

laufen habe ich den Eindruck, dass ich das zusätzliche Argument verwenden können --haddock Dokumentation für mein eigenes Projekt zu generieren, und --no-haddock-deps die Dokumentation für meine Abhängigkeiten auszulassen. Wenn ich jedoch

stack haddock --haddock --no-haddock-deps 

läuft scheint nichts passieren. Wenn ich zuerst stack clean alles meinen Code neu kompiliere, aber keine Ausgabe generiert wird, scheint in irgendeiner Weise auf Dokumentation zu beziehen.

Als Zwischenlösung ich auch selbst versucht haben, laufen Haddock, das heißt

haddock my-source.hs 

aber dann bekomme ich einen Fehler, dass es nicht ein Modul die Datei hängt davon ab, (die lokal durch Stapel installiert ist) finden kann. Dies gibt mir den Eindruck, dass die Dokumentationsgenerierung irgendwie durch den Stack gehen muss. Ich habe gesucht, aber nicht wirklich irgendwelche Erklärungen im Zusammenhang mit der Konfiguration meiner .cabal und stack.yaml Dateien für die Dokumentation gefunden.

TL; DR

Wie kann ich Stack und Haddock Dokumentation für den Code in meinem eigenen Paket zu generieren?

Answer 1

Nach this ticket auf dem Stack Issue Tracker kann Stack derzeit nur Dokumentation für Bibliotheken erstellen, aber keine ausführbaren Dateien.

Cabal kann so konfiguriert werden, um mit diesem Befehl mit den Stack-Datenbanken zu arbeiten:

cabal configure --package-db=clear --package-db=global --package-db=$(stack path --snapshot-pkg-db) --package-db=$(stack path --local-pkg-db) 

nach dem Sie cabal haddock --executables ausführen können, die Dokumentation zu erzeugen.

Übrigens ist stack haddock nur eine Abkürzung für stack build --haddock, so dass es keine Notwendigkeit gibt, stack haddock --haddock zu schreiben.

Answer 2

https://www.reddit.com/r/haskell/comments/5ugm9s/how_to_generate_haddock_docs_for_nonlibrary_code/ddtwqzc/

Die folgende Lösung funktioniert nur, wenn einzelne Dateien angegeben werden:

stack exec -- haddock --html src/Example.hs src/Main.hs --hyperlinked-source --odir=dist/docs