इस पृष्ठ पर

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

Sphinx परियोजना का माइग्रेशन

Guidedog Sphinx की प्रोजेक्ट संरचना और कई सेटिंग नाम अपनाता है। वह conf.py या Python एक्सटेंशन नहीं चलाता। माइग्रेशन की शुरुआत डेटा को चलने वाले कॉन्फ़िगरेशन से अलग करने से होती है।

guidedog migrate path/to/conf.py
guidedog build html path/to/docs --diagnostics=json

migrate लिटरल सेटिंग पढ़कर conf.toml लिखता है। गणना से आए मानों में जहाँ मानव निर्णय चाहिए, वह बताता है। उन्हें जानने के लिए प्रोजेक्ट इंपोर्ट या Python नहीं चलाता। समान मानने से पहले बना कॉन्फ़िगरेशन जाँचें।

तीन चरणों में काम करें

1. दस्तावेज़ ग्राफ़ सही करें। रूट, प्रत्यय, बहिष्करण और include जाँचें।
2. संदर्भ सही करें। डोमेन, इन्वेंटरी और कस्टम ऑब्जेक्ट टाइप जाँचें।
3. प्रस्तुति सही करें। टेम्पलेट, आरेख, गणित और दोनों आउटपुट जाँचें।

अज्ञात निर्देश प्रोजेक्ट के निजी एक्सटेंशन का हो सकता है। HTML बिल्ड की सफलता उसके अर्थ के पुनरुत्पादन का प्रमाण नहीं। निदान पढ़ें। फिर निर्देश बदलें, समर्थित उपनाम दें, या सीमा दर्ज करके बनाए रखें।

समर्थित सुविधाएँ और CPython, Django, Flask के प्रमाण Sphinx के साथ संगतता में हैं। घोषणात्मक कस्टम ऑब्जेक्ट के लिए ऑब्जेक्ट टाइप घोषित करना देखें।