Haddock ve yığın ile kendi kodum için belge oluşturma

Question

Haddock stilinde koduma açıklama ekledim ve göz atılabilir belgeler oluşturmak istiyorum. Yığını da kullandığım için, dokümantasyon oluşturmayı iş akışına entegre etmek istiyorum. Ancak, henüz yararlı bir şey üretemedim.

Ben

stack haddock 

çalıştırabilir ve bunun bana göre tarzında belgeler üretecek (derin ~/.stack/ içine bulunacak), ancak yalnızca için daha doğrusu, ben bağımlı paketleri belgeleri oluşturmak gibi görünüyor kendi kodum Ben

stack haddock --help 

çalıştırdığınızda

benim bağımlılıkları belgelerine bırakmak kendi projesi için belgeleri oluşturmak için ek argüman --haddock kullanın ve --no-haddock-deps olabilir izlenimini olsun. Ancak,

'u çalıştırdığımda hiçbir şey olmuyor. İlk önce stack clean ise tüm kodumu yeniden derler, ancak belgelere herhangi bir şekilde benzeyecek bir çıktı üretilmez. Ayrıca tek başına Haddock çalışan çalıştık bir ara çözüm olarak

yani

haddock my-source.hs 

fakat daha sonra dosyası (yığını tarafından yerel olarak yüklü olan) bağlı olan bir modül bulamadığını bir hata olsun. Bu bana, dokümantasyon üretiminin bir şekilde yığından geçmek zorunda olduğu izlenimini veriyor. Aradığım için, .cabal ve stack.yaml dosyalarının belgelenmesiyle ilgili herhangi bir açıklama bulunamadı.

TL; DR

Nasıl kendi paketinde kodu belgelerine üretmek için yığını ve Haddock kullanabilirim?

Answer 1

Yığın sorunu izleyicisindeki this ticket'a göre, Yığın şu anda yalnızca kitaplıklar için belgeler oluşturabilir, ancak yürütülebilir dosyaları değil.

Cabal bu komutla yığın veri tabanları ile çalışmak üzere konfigüre edilebilir:

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

bundan sonra belgeleri oluşturmak için cabal haddock --executables çalışabilir.

Bu arada, stack haddock yalnızca stack build --haddock için bir kısayol olduğundan, stack haddock --haddock yazmanıza gerek yoktur.

Answer 2

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

aşağıdaki çözüm sadece bireysel dosyalar belirtildiğinde çalışır:

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