हैडॉक और स्टैक

Question

के साथ अपने कोड के लिए प्रलेखन जेनरेट करना मैंने हैडॉक शैली में अपना कोड एनोटेट किया है और ब्राउज़-सक्षम दस्तावेज जेनरेट करना चाहता हूं। चूंकि मैं ढेर का उपयोग भी कर रहा हूं, इसलिए मैं वर्कफ़्लो में प्रलेखन पीढ़ी को एकीकृत करना चाहता हूं। हालांकि, मैं अभी तक कुछ भी उपयोगी उत्पन्न करने में सक्षम नहीं हुआ है।

मैं

stack haddock 

चला सकते हैं और यह शैली मैं चाहता हूँ में प्रलेखन उत्पन्न होगा (~/.stack/ गहरे अंदर पाया जा सकता है), लेकिन यह केवल के लिए की तुलना में, संकुल मैं पर निर्भर के लिए प्रलेखन उत्पन्न करने के लिए लगता है बल्कि मेरा अपना कोड

जब मैं

stack haddock --help 

चलाने मैं धारणा है कि मैं अतिरिक्त तर्क --haddock का उपयोग अपने ही परियोजना के लिए प्रलेखन उत्पन्न करने के लिए कर सकते हैं और --no-haddock-deps मेरी निर्भरता के लिए प्रलेखन बाहर छोड़ने के लिए मिलता है। हालांकि, जब मैं

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

कुछ भी नहीं होने लगता है। अगर मैं stack clean पहले यह मेरे सभी कोड को फिर से संकलित कर दूंगा लेकिन दस्तावेज़ीकरण के किसी भी तरीके से संबंधित कोई आउटपुट उत्पन्न नहीं होता है।

एक मध्यवर्ती समाधान मैं भी अपने आप में हेडॉक चलाने का भी प्रयास किया है, अर्थात

haddock my-source.hs 

लेकिन फिर मैं एक त्रुटि है कि यह एक मॉड्यूल फ़ाइल पर निर्भर करता है (जो स्थानीय स्तर पर ढेर द्वारा स्थापित किया गया है) नहीं मिल सकता है मिलता है। यह मुझे इंप्रेशन देता है कि दस्तावेज़ीकरण पीढ़ी को किसी भी तरह से ढेर करना होगा। मैंने देखा है, लेकिन वास्तव में मेरे .cabal और stack.yaml फ़ाइलों को दस्तावेज़ीकरण के लिए कॉन्फ़िगर करने से संबंधित कोई स्पष्टीकरण नहीं मिला है।

टी एल; डॉ

मैं ढेर और हेडॉक का उपयोग कैसे अपने ही पैकेज में कोड के लिए प्रलेखन उत्पन्न करने के लिए कर सकते हैं?

Answer 1

स्टैक इश्यू ट्रैकर पर this ticket के अनुसार, स्टैक वर्तमान में केवल पुस्तकालयों के लिए प्रलेखन बना सकता है, लेकिन निष्पादन योग्य नहीं है।

कबाल इस आदेश के साथ ढेर डेटाबेस के साथ काम करने के लिए कॉन्फ़िगर किया जा सकता है:

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

जिसके बाद आप cabal haddock --executables चलाने प्रलेखन उत्पन्न करने के लिए कर सकते हैं।

वैसे, stack haddockstack build --haddock के लिए केवल एक शॉर्टकट है, इसलिए stack haddock --haddock लिखने की कोई आवश्यकता नहीं है।

Answer 2

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

निम्नलिखित समाधान केवल काम करता है जब अलग-अलग फ़ाइलों निर्दिष्ट कर रहे हैं:

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