के बीच अंतर मैं Numpy-style docstrings का उपयोग कर एक पायथन परियोजना के लिए प्रलेखन लिख रहा हूं।sphinxcontrib.napoleon और numpy.numpydoc
numpydoc और napoleon दो स्फिंक्स एक्सटेंशन हैं जो दस्तावेज उत्पन्न करने के लिए नम्पी-शैली डॉकस्ट्रिंग का विश्लेषण करते हैं। पहले व्यक्ति को नम्पी प्रोजेक्ट के लिए इस्तेमाल किया जाता है, दूसरा स्पिंक्स के साथ भेज दिया जाता है।
दूसरे पर एक एक्सटेंशन का उपयोग करने के पेशेवर और विपक्ष क्या हैं?
प्रत्येक थोड़ी अलग की जिसके परिणामस्वरूप प्रारूप, और python दस्तावेज में जाना जाता डेटाटाइप्स को napoleon लिंक के डिफ़ॉल्ट व्यवहार, और यह थोड़ा और अधिक सघन है (numpydoc प्रदर्शित करता है कि यह कैसे docstring में प्रकट होता है की तरह एक बिट)। नीचे डिफ़ॉल्ट sphinx विषय का उपयोग कर दोनों के उदाहरण हैं।
An issueastropy की समस्या ट्रैकर जो यह बताता है napolean में IPython के लिए एक कठिन निर्भरता है, और वे के बाद से numpydoc से napolean में चले गए।
उनका उल्लेख है कि इसमें कठोर सिंटैक्स आवश्यकताएं हैं, लेकिन मैंने उस पर टिप्पणी करने के लिए बहुत अधिक परीक्षण नहीं किया है।
नेपोलियन
numpydoc
