Guidedog मैनुअल 0.2.0
भाषा
इस पृष्ठ पर
Guidedog / दस्तावेज़ 0.2.0

दस्तावेज़ बिल्ड और प्रकाशित करना

परियोजना की सामान्य आउटपुट निर्देशिका में बिल्ड करें:

guidedog build html docs/manual -j auto -W
guidedog build pdf docs/manual -W

साइट docs/manual/_build/html में है। PDF और बना Typst सोर्स docs/manual/_build/pdf में हैं। वेब सर्वर HTML फ़ोल्डर को स्थिर फ़ाइलों की तरह दे सकता है। उत्पादन में Odin सर्वर आवश्यक नहीं।

आउटपुट निर्देशिका चुनना

Sphinx जैसा रूप स्रोत और गंतव्य स्पष्ट देता है:

guidedog build -b html docs/manual build/manual-site -W

आउटपुट सोर्स के बाहर रखें। प्रकाशन से सोर्स ट्री बदलने वाली संरचना Guidedog अस्वीकार करता है। कस्टम लक्ष्य build/.manual-site.guidedog/.doctrees जैसे स्थिर, समान स्तर के कैश का उपयोग करता है। इसलिए प्रकाशन फ़ोल्डर में केवल प्रकाशित सामग्री रहती है।

प्रीव्यू और जाँच

guidedog serve docs/manual
guidedog build dummy docs/manual -n -W

dummy बिल्डर प्रोजेक्ट पढ़कर संबंध हल करता है, प्रकाशन नहीं बनाता। अर्थ की त्वरित जाँच के लिए इस्तेमाल करें। अंतिम लेआउट इससे नहीं जँचता।

दोहराने योग्य समय

SOURCE_DATE_EPOCH=1790812800 guidedog build html docs/manual -W

इससे बिल्ड का समय तय होता है। पुनरुत्पाद्यता सोर्स, टेम्पलेट, फ़ॉन्ट, कंपाइलर संस्करण और संसाधनों पर भी निर्भर है। केवल समय तय करना काफ़ी नहीं।

बिल्ड सफल होने पर पूरा फ़ोल्डर प्रकाशित करें। सफल निकास आवश्यक है; टेम्पलेट बदलने पर दृश्य जाँच भी चाहिए।