इस पृष्ठ पर

Guidedog / दस्तावेज़ 0.2.0

परियोजना कैसे काम करती है

प्रोजेक्ट मूल conf.toml वाला फ़ोल्डर है। root_doc पढ़ने का पहला दस्तावेज़ है। Guidedog सोर्स खोजता, पढ़ता, संबंध हल करता और पूरा आउटपुट संस्करण प्रकाशित करता है।

चित्र 2 बिल्ड खोज, अर्थ, प्रस्तुति और प्रकाशन को अलग रखता है।

दस्तावेज़ और संसाधन

प्रत्यय रीडर चुनता है। RST और प्रोजेक्ट Markdown एक ग्राफ़ साझा करते हैं। चित्र व डाउनलोड संसाधन हैं; उपयोग किए संसाधन कॉपी होते हैं। थीम सामग्री html_static_path में है। include सोर्स या दिए include_roots के भीतर हो।

अलग परियोजनाएँ

मैनुअल और डिज़ाइन रिकॉर्ड अलग प्रोजेक्ट रखें। पाठक और पढ़ने का क्रम अलग हैं। हर एक का अपना कॉन्फ़िगरेशन, टेम्पलेट, कैश और आउटपुट है। Guidedog में docs/manual और docs/gds ऐसे हैं।

इन्क्रिमेंटल बिल्ड

Guidedog हर आउटपुट के इनपुट और खोज दर्ज करता है। बदला सोर्स फिर पढ़ता है। निर्भरता बदलने पर उपयोगकर्ता अमान्य होते हैं। टेम्पलेट सभी पेज बदल सकता है। अपरिवर्तित दस्तावेज़ सहेजे ऑब्जेक्ट से लोड हो सकता है।

कैश पिछली बिल्ड का प्रमाण है, मूल सत्य नहीं। -E अगली बिल्ड के लिए सहेजा वातावरण हटाता है। -a सभी आउटपुट लिखता है। ये अलग समस्याएँ हल करते हैं।

\[\text{पुनः उपयोग} = \text{समान इनपुट} \land \text{समान खोज परिणाम} \land \text{आउटपुट मौजूद}\]

टेम्पलेट का स्पष्ट टाइमस्टैम्प भी पेज इनपुट है। वर्तमान मिनट दिखाता पेज पाठ बदले बिना बदल सकता है। तय समय के लिए SOURCE_DATE_EPOCH दें।

प्रकाशन

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