स्फिंक्स और Argparse - autodocumenting कमांड लाइन स्क्रिप्ट?

Question

मैं एक पायथन पैकेज बना रहा हूं, और दस्तावेज़ बनाने के लिए स्फिंक्स का उपयोग कर रहा हूं। मेरे पैकेज कोड के अलावा, मैं बहुत कमांड लाइन पायथन स्क्रिप्ट्स भी शामिल करता हूं, जो argparse का उपयोग करते हैं। मैं सोच रहा था कि क्या स्प्रिंक्स को इन स्क्रिप्ट्स को स्वत: दस्तावेज करने का कोई तरीका है? अंतिम लक्ष्य संबंधित सहायता प्रिंट, तर्क और विकल्पों के साथ स्क्रिप्ट की एक सुंदर मुद्रित सूची होगी। और स्पष्ट होने के लिए, मैं इसे करने के लिए एक पूर्व-मौजूदा तरीका ढूंढ रहा हूं, इसे स्वयं लागू करने का कोई तरीका नहीं।

यह एक प्रश्न के विशिष्ट नहीं है जैसा कि मैं आमतौर पर एसओ पर पूछता हूं, यदि कोई और उचित एसई है। इस सवाल को पोस्ट करने के लिए साइट, कृपया मुझे बताएं। धन्यवाद।

Answer 1

आप अपने दस्तावेज़ में कमांड लाइन से मदद संदेश शामिल करने के लिए sphinxcontrib.programoutput का उपयोग कर सकते हैं।

यह argparse के लिए विशिष्ट नहीं है लेकिन कमांड लाइन पर किसी स्क्रिप्ट प्रिंटिंग सहायता संदेशों को दस्तावेज़ित करने के लिए उपयोग किया जा सकता है। स्फिंक्स-argparse विस्तार

Answer 2

उपयोग:

http://sphinx-argparse.readthedocs.org/en/latest/

Answer 3

आप sphinxcontrib.autoprogram उपयोग कर सकते हैं। pip install sphinxcontrib-autoprogram, तो अपने conf.py में

extensions += ['sphinxcontrib.autoprogram'] 

डाल दिया। argparse parser वस्तु parser (जो एक अजगर अभिव्यक्ति हो सकती है, एक समारोह get_parser() की तरह) के साथ cli आयात द्वारा आदेश cli.py दस्तावेज़ करने के लिए, का उपयोग

.. autoprogram:: cli:parser 
    :prog: cli.py