2014-10-24 13 views
7

उत्पन्न करता है मैं अपने प्रोजेक्ट को दस्तावेज़ बनाने के लिए Sphinx का उपयोग कर रहा हूं। मैंने अपनी कॉन्फ़िगरेशन फ़ाइल में sphinx.ext.coverage एक्सटेंशन सक्षम किया है। मैं निम्न आदेश चल रहा हूँ (के रूप में this answer द्वारा निर्देशित कवरेज रिपोर्ट जनरेट करने:स्फिंक्स कवरेज खाली python.txt फ़ाइल

bash-3.2$ sphinx-build -v -b coverage . _build/coverage/ 
Making output directory... 
Running Sphinx v1.2.3 
loading pickled environment... not yet created 
building [coverage]: coverage overview 
updating environment: 10 added, 0 changed, 0 removed 
... 
reading sources... [100%] modules 
looking for now-outdated files... none found 
pickling environment... done 
checking consistency... /some/path/modules.rst:: WARNING: document isn't included in any toctree 
done 
build succeeded, 17 warnings. 

अगर मैं _build/कवरेज/python.txt अंदर देखो, सब मैं देख रहा है:

Undocumented Python objects 
=========================== 

यह नहीं बहुत सही, के बाद से वहाँ निश्चित रूप से कर रहे हैं अपने प्रोजेक्ट के कुछ हिस्सों कि दस्तावेज नहीं कर रहे हैं स्फिंक्स मेलिंग सूची पर इस बारे में किसी ने posted है।

, लेकिन कोई जवाब नहीं मिला।

+०१२३५१६४१०

क्या कोई जानता है कि समस्या क्या है? मैं इसे कैसे ठीक करूं?

उत्तर

4

विचार करने के लिए एक बात - यदि आप :undoc-members: का उपयोग कर रहे हैं, तो उन्हें दस्तावेज माना जाएगा, भले ही वे स्टब से ज्यादा कुछ नहीं हैं। यही कारण था कि मुझे कोई परिणाम नहीं मिला।

+1

स्पिन्क्स-ऑटोोडोक के साथ मेरे दस्तावेज़ को जेनरेट करने के बाद भी यही समस्या थी। यह स्वीकार्य उत्तर होना चाहिए। – rpkelly

3

अपने कार्य नहीं docstring है, लेकिन अपने .rst फ़ाइल की 'सामग्री' भाग में निर्दिष्ट किया जाता है, तो यह अभी भी रूप में कवरेज बिल्डर द्वारा 'कवर' पर विचार किया जाएगा, और अपने python.txt में खड़े नहीं

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