कोडबेस के दस्तावेज़ बनाना¶
सार्वजनिक नाम के साथ अनुबंध चाहिए। इनपुट, परिणाम, स्वामित्व और विफलता की शर्तें समझाएँ। केवल सिग्नेचर से मैनुअल नहीं बनता।
Odin¶
odin_autoapi_dirs = ["../../lib"]
odin_autoapi_root = "api"
odin_autoapi_options = ["members", "undoc-members"]
Guidedog Odin के पार्सर से सोर्स पढ़ता है। वह संबंधित पैकेज को संकलित या चलाता नहीं। बने हुए पेज दस्तावेज़ ग्राफ़ और ऑब्जेक्ट सूची में जुड़ते हैं। इस रिपॉज़िटरी का अलग API प्रोजेक्ट docs/api है। निर्देश, सिग्नेचर और विकल्प के लिए Odin के दस्तावेज़ बनाना देखें।
Python¶
extensions = ["sphinx.ext.autodoc"]
autodoc_source_paths = ["../src"]
Guidedog Python सोर्स को पार्स करता है, इंपोर्ट नहीं। इससे इंपोर्ट के दुष्प्रभाव बचते हैं। रनटाइम पर बने ऑब्जेक्ट छूट सकते हैं। सार्वजनिक इंटरफ़ेस का हिस्सा हों तो उन्हें स्पष्ट रूप से लिखें। खोज के सटीक नियम autodoc से Python का दस्तावेज़ीकरण में हैं।
परियोजनाओं के बीच लिंक¶
बना हुआ objects.inv साइट के साथ प्रकाशित करें। दूसरे प्रोजेक्ट का intersphinx मैपिंग उससे नाम हल कर सकता है। पुनरुत्पाद्य बिल्ड के लिए स्पष्ट मैपिंग दें। अन्य परियोजनाओं से लिंक देखें।