2012-08-20 13 views
5

मैं सोच रहा था कि पाइथन के साथ पीओडी (सादा पुराना दस्तावेज) का उपयोग करना संभव है? और मुझे यह कैसे करना चाहिए?क्या पाइथन के साथ पीओडी (सादा पुराना दस्तावेज) का उपयोग करना संभव है?

+2

आपको इसकी आवश्यकता क्यों है। पायथन का अपना खुद का डॉकस्ट्रिंग प्रारूप है जिसे 'पायडोक' द्वारा व्याख्या किया जाता है। यदि आप पीओडी का उपयोग करते हैं, तो आपके मॉड्यूल के उपयोगकर्ताओं को इसे पढ़ने के लिए एक टूल की आवश्यकता होगी। क्या आप वाकई यही चाहते हैं? यदि आप बस अपना कोड दस्तावेज करना चाहते हैं, तो पाइथन के डॉकस्ट्रिंग का उपयोग करें। – javex

उत्तर

1

पाइथन फ़ाइल में पीओडी इनलाइन का उपयोग करने के लिए सीधे समर्थित तरीका प्रतीत नहीं होता है। हालांकि, पायथन मॉड्यूल (पायथन मानक लाइब्रेरी समेत) reStructuredText का उपयोग करके दस्तावेज किया गया है। यह आमतौर पर Sphinx का उपयोग करके किया जाता है, जो पुनर्नवीनीकरण टेक्स्ट-स्वरूपित दस्तावेज़ों से दस्तावेज़ तैयार करता है। स्फिंक्स और आरएसटी विशेष रूप से पीओडी के लिए एक समान जगह भरने के लिए डिजाइन किए गए थे।

संबंधित मुद्दे