2013-03-06 10 views
6

में दो डैश को कैसे संभालें I Python में लिखी गई कमांड लाइन उपयोगिता दस्तावेज करने के लिए स्फिंक्स का उपयोग कर रहा हूं। मैं इस तरह के --region इस तरह के रूप में एक कमांड लाइन विकल्प दस्तावेज़ के लिए, सक्षम होना चाहते हैं:रीस्ट

**--region** <region_name> 
बाकी हिस्सों में

और फिर स्फिंक्स का उपयोग मेरे लिए मेरी HTML और आदमी पृष्ठों को उत्पन्न करने के लिए।

मैन पेज उत्पन्न करते समय यह बहुत अच्छा काम करता है लेकिन जेनरेट किए गए HTML में, --- में बदल जाता है जो गलत है। मैंने पाया है कि अगर मैं अपने स्रोत बाकी दस्तावेज़ बदलने के इस तरह देखने के लिए है:

**---region** <region_name> 

एचटीएमएल सही ढंग से उत्पन्न करता है लेकिन अब मेरा आदमी पृष्ठों --- बजाय -- है। भी गलत है।

मैंने बैकस्लैश चरित्र (उदा। \-\-) के साथ डैश से बचने का प्रयास किया है, लेकिन इसका कोई प्रभाव नहीं पड़ा।

किसी भी मदद की बहुत सराहना की जाएगी।

+1

मुझे पता चला है कि इसका एक आसान समाधान कोड मार्कअप के अंदर डबल-हाइफ़न को लपेटना है, उदा। \ * \ '--region \' \ 'के बजाय \ * \ * - क्षेत्र \ * \ *। इसे हल करने के लिए और अधिक सुरुचिपूर्ण तरीके हो सकते हैं लेकिन यह मेरे लिए काम करता है। – garnaat

+3

शायद आप एक विकल्प सूची का उपयोग कर सकते हैं: http://docutils.sourceforge.net/docs/ref/rst/restructuredtext।एचटीएमएल # विकल्प-सूचियां – mzjn

+0

हाँ, यह उचित लगता है। धन्यवाद, अभी भी हर समय आरईएसटी में नई चीजें खोज रहे हैं! – garnaat

उत्तर

2

यह स्फिंक्स में एक कॉन्फ़िगरेशन विकल्प है जो डिफ़ॉल्ट रूप से चालू होता है: html_use_smartypants विकल्प (http://sphinx-doc.org/config.html?highlight=dash#confval-html_use_smartypants)।

यदि आप विकल्प बंद करते हैं, तो आपको यूनिकोड वर्ण '-' का उपयोग करना होगा यदि आप एक एन-डैश चाहते हैं।

+0

यह निश्चित रूप से एक कामकाज है। मैं इस व्यवहार को बग के रूप में मानता हूं, हालांकि एंडशैश के साथ '---' को पहले और '---' के बाद emdash के साथ बदलना इतना कठिन नहीं हो सकता है। – TNT

+1

और इस सुविधा के अर्थ में उदाहरण के लिए '': कमांड: 'sphinx-build --version' '' एक "टाइपोग्राफ़िकली सही" कमांड लाइन उत्पन्न करता है:' sphinx-build --version' ... – TNT

0

दो डैश जोड़ने के लिए, निम्नलिखित जोड़ें:

.. include:: <isotech.txt> 

|minus|\ |minus|\ region 

नोट पश्चगामी-स्लैश और अंतरिक्ष। यह शून्य संकेतों और पैरामीटर के नाम के बीच एक जगह रखने से बचाता है।

आपको प्रति पृष्ठ एक बार केवल isotech.txt शामिल करने की आवश्यकता है।

इस समाधान के साथ, आप एक्सटेंशन स्मार्टपैंट्स को रख सकते हैं और आपको आवश्यक पाठ के प्रत्येक भाग में दो डैश लिख सकते हैं। न केवल विकल्प सूचियों या शाब्दिक में।

0

स्फिंक्स 1.6 html_use_smartypants has been deprecated में, और यह अब आवश्यक हो तो अपनी conf.py में या sphinx-build लिए एक तर्क के रूप html_use_smartypants = False स्थापित करने के लिए है। इसके बजाय आपको smart_quotes = False का उपयोग करना चाहिए।

आप परिवर्तनों पूर्व html_use_smartypants द्वारा प्रदान का उपयोग करना चाहते हैं, तो बजाय यह smart_quotes, उदाहरण के लिए, smart_quotes = True उपयोग करने के लिए सिफारिश की है।

ध्यान दें कि इस लेखन के समय डॉक्स पिन sphinx==1.5.3 पढ़ें, जो smart_quotes विकल्प का समर्थन नहीं करता है। तब तक, आपको html_use_smartypants का उपयोग जारी रखना होगा।

+0

स्पष्ट करने के लिए, [जिस दस्तावेज़ से आपने लिंक किया है] (http://www.sphinx-doc.org/en/stable/config.html#confval-html_use_smartypants) कहता है, 'smart_quotes = false' (या' no' या 'off') 'conf.py' के समान स्तर पर 'docutils.conf' फ़ाइल करने के लिए, afaik से संबंधित है। – jfbu

0
साथ

**-\\-region** <region_name> 

यह काम करना चाहिए

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