python-sphinx
ऑटोकॉक का उपयोग करते हुए डॉकस्ट्रिंग्स लिखना
खोज…
परिचय
स्फिंक्स को ऑटोकॉक एक्सटेंशन का उपयोग करके प्रलेखन में डॉकस्ट्रिंग्स को शामिल करने की अनुमति मिलती है जिसे पैकेज के साथ भेज दिया जाता है। यह दस्तावेज़ आपको दिखाएगा कि आपके दस्तावेज़ों को कैसे प्रारूपित किया जाए कि उन्हें अपने दस्तावेज़ में कैसे शामिल किया जाए।
ऑटोडोक एक्सटेंशन स्थापित करना
अपने डॉक्यूमेंट के रूट में conf.py फ़ाइल में मौजूद extensions list में conf.py मॉड्यूल जोड़ें:
extensions = [
'sphinx.ext.autodoc',
...
]
स्फिंक्स कॉन्फ़िगरेशन में अपना कोड पथ जोड़ना
ऑटोडोक को अपने मॉड्यूल को काम करने के लिए आयात करने की आवश्यकता है।
आप अपने में अपने कोड पथ शामिल कर सकते हैं conf.py फ़ाइल।
उदाहरण के लिए:
import os
sys.path.insert(0, os.path.abspath('../src'))
Modified text is an extract of the original Stack Overflow Documentation
के तहत लाइसेंस प्राप्त है CC BY-SA 3.0
से संबद्ध नहीं है Stack Overflow