2016-05-13 7 views
6

स्फिंक्स के लिए स्फिंक्स के साथ HTML में वर्णानुक्रमित सभी विधि/फ़ंक्शन नामों से बचने के लिए कैसे संभव है? मैं उन्हें उसी क्रम में रखना चाहता हूं क्योंकि वे स्रोत कोड में पाए जाते हैं।पायथन - वर्णमाला क्रम में स्फिंक्स आउटपुट को सॉर्ट करने के लिए कैसे करें

उत्तर

12
sphinx.ext.autodoc documentation से

:

autodoc_member_order

यह मान का चयन करता है, तो स्वचालित रूप से प्रलेखित सदस्यों सदस्य प्रकार (मूल्य 'ग्रुपवाइज') द्वारा वर्णमाला (मूल्य 'वर्णमाला') हल कर रहे हैं, या स्रोत आदेश से (मान 'बायसोर्स')। डिफ़ॉल्ट वर्णमाला है।

ध्यान दें कि स्रोत आदेश के लिए, मॉड्यूल उपलब्ध स्रोत कोड के साथ एक पायथन मॉड्यूल होना चाहिए।

तो अपने conf.py फ़ाइल में कहीं, डाल:

autodoc_member_order = 'bysource' 
+0

धन्यवाद @James। मैनें इसे खो दिया। –

+0

यदि स्पिंक्स को आपका स्रोत कोड नहीं मिल रहा है, तो सुनिश्चित करें कि आपके पास 'sy.py.path.insert (0, os.path.abspath ('path/to/source') के माध्यम से' conf.py' में पथ शामिल है। मेरे मामले में, यह पथ गलत था लेकिन स्फिंक्स ने कोई त्रुटि नहीं दी क्योंकि मॉड्यूल भी स्थानीय रूप से स्थापित किया गया था और बिना किसी समस्या के आयात किया जा सकता था, भले ही स्फिंक्स को स्रोत कोड नहीं मिला। – eatcrayons

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