इन दस्तावेज़ों का रखरखाव¶
Guidedog के तीन प्रोजेक्ट हैं: docs/manual, docs/api और docs/gds। मैनुअल और GDS guidedog quickstart से बने। बने हुए टेम्पलेट सीधे संपादित करें। डिज़ाइन रिकॉर्ड मैनुअल की विषय-सूची में न रखें।
मैनुअल बिल्ड करना¶
रिपॉज़िटरी के रूट से:
build/guidedog build html docs/manual -j auto -W
build/guidedog build pdf docs/manual -W
build/guidedog serve docs/manual
मैनुअल की विषय-सूची में पूरा Odin API संदर्भ है। PDF कमांड व्याख्या और घोषणाओं को लिंक करती एक पुस्तक बनाता है। मैनुअल और अलग API प्रोजेक्ट दोनों lib/ से संदर्भ बनाते हैं। API की नकल की हुई पांडुलिपि अलग से सँभालनी नहीं पड़ती।
केवल API परियोजना बिल्ड करने के लिए:
build/guidedog build html docs/api -W
build/guidedog build pdf docs/api -W
चर्चा दस्तावेज़ बिल्ड और जाँचना¶
build/guidedog gds index
build/guidedog gds check
build/guidedog gds build --target=both
GDS CLI मेटाडेटा, संख्या, स्थिति और रिकवरी सँभालता है। RST प्रकाशन प्रोजेक्ट इंजन बुलाकर पूरी HTML साइट और हर रिकॉर्ड का अलग PDF बनाता है। चयन केवल PDF सीमित करता है; HTML में पूरा कैटलॉग रहता है। चुने हुए PDF का प्रीव्यू _build/selected/<artifact>/pdf में होता है और _build/pdf का पूरा कैटलॉग सुरक्षित रहता है।
build/guidedog gds build guidedoc-odin --target=pdf
build/guidedog build html docs/gds -W
build/guidedog build pdf docs/gds -W
सामान्य प्रोजेक्ट कमांड भी चलते हैं। GDS का अपना conf.toml और _build फ़ोल्डर है। लेखन प्रक्रिया docs/gds/workflow.rst में पढ़ें।
प्रकाशन से पहले¶
लिंक, निदान, चौड़ी तालिकाएँ और कोड ब्लॉक जाँचें। टाइपोग्राफ़ी बदलने पर PDF पेज रेंडर करके देखें। HTML को डेस्कटॉप और फ़ोन की चौड़ाई, हल्के और गहरे थीम में जाँचें। गणित और आरेख बिना नेटवर्क भी चलने चाहिए। इंजन बदलने पर संबंधित लाइब्रेरी और एकीकरण टेस्ट चलाएँ।