किसी फ़ंक्शन या दस्तावेज़ के बारे में जानकारी किसी फ़ंक्शन में डॉकस्ट्रिंग में डाल दी जाती है। डॉकस्ट्रिंग लिखते समय निम्नलिखित दिशा-निर्देशों का पालन किया जाना चाहिए।
पहली पंक्ति हमेशा वस्तु के उद्देश्य का संक्षिप्त, संक्षिप्त सारांश होनी चाहिए। संक्षिप्तता के लिए, इसे स्पष्ट रूप से वस्तु का नाम या प्रकार नहीं बताना चाहिए। यह पंक्ति एक बड़े अक्षर से शुरू होनी चाहिए और एक अवधि के साथ समाप्त होनी चाहिए।
यदि दस्तावेज़ीकरण स्ट्रिंग में अधिक पंक्तियाँ हैं, तो दूसरी पंक्ति रिक्त होनी चाहिए, जो सारांश को शेष विवरण से दृष्टिगत रूप से अलग करती है
स्फिंक्स
स्फिंक्स सबसे लोकप्रिय पायथन प्रलेखन उपकरण है। यह रीस्ट्रक्चर्ड टेक्स्ट मार्कअप भाषा को HTML, LaTeX (प्रिंट करने योग्य PDF संस्करणों के लिए), मैनुअल पेज और प्लेन टेक्स्ट सहित आउटपुट स्वरूपों की एक श्रृंखला में परिवर्तित करता है।
चलाते समय, स्फिंक्स आपके कोड को आयात करेगा और पायथन की आत्मनिरीक्षण सुविधाओं का उपयोग करके यह सभी फ़ंक्शन, विधि और वर्ग हस्ताक्षर निकालेगा। यह साथ के डॉकस्ट्रिंग को भी निकालेगा, और इसे आपके प्रोजेक्ट के लिए अच्छी तरह से संरचित और आसानी से पढ़ने योग्य दस्तावेज़ों में संकलित करेगा।