2013-01-24 75 views
11

एचटीएमएल दस्तावेज बनाने के दौरान, आप मौजूद लिंक पर स्पिंक्स को रिपोर्ट करने या त्रुटि बनाने के लिए कैसे मजबूर करते हैं?में स्पिंक्स रिपोर्ट टूटी हुई लिंक

विशेष रूप से, मेरे पास पाइथन परियोजना के भीतर गुण और विधियां हैं जिन्हें हटा दिया गया है या नाम दिया गया है, और स्फिंक्स जेनरेट किए गए HTML आउटपुट के साथ सभी मृत लिंक ढूंढना मुश्किल है।

मुझे लगता है कि मैं यहां जवाब पर देख रहा हूं: http://sphinx-doc.org/glossary.html, जैसा कि शुरुआती अनुच्छेद में वर्णित है।

मैं स्पष्ट रूप से कुछ समझ नहीं रहा हूं।

उत्तर

4

मुझे लगता है कि CheckExternalLinksBuilder वह है जो आप खोज रहे हैं।

इसका मूल रूप से -b linkcheck विकल्प के साथ 'स्फिंक्स-बिल्ड' को कॉल करके उपयोग किया जाता है। अधिक जानकारी के लिए कृपया sphinx-build देखें। साथ ही, स्फिंक्स-एक्सटेंशन here और here की सूची देखें।

+2

यह मेरे पायथन परियोजना के भीतर गुणों और विधियों को खोजने के लिए काम नहीं करता है जिन्हें हटा दिया गया है या नाम दिया गया है। यह केवल बाहरी लिंक के लिए काम करता प्रतीत होता है। – Idaho

+0

ठीक है, मैं देखता हूं। मुझे यकीन नहीं है कि टूटी हुई संपत्तियों या विधियों को ढूंढना स्फिंक्स का काम है। पिलिंट की तरह लगता है, pyflakes नौकरी के लिए सही उपकरण हैं। – alecxe

12

nitpicky कॉन्फ़िगरेशन चर True पर सेट करें (आप sphinx-build चलाते समय -n option का भी उपयोग कर सकते हैं)।

नाइटपीकी मोड में, किसी फ़ंक्शन के लिए क्रॉस-रेफरेंस (जैसे :func:`myfunc`), कक्षा, या अन्य ऑब्जेक्ट जो नहीं मिल सका, एक चेतावनी संदेश उत्पन्न करेगा।

+0

भयानक, परियोजनाओं में "nitpicky = True" जोड़कर conf.py फ़ाइल ने इसे ठीक किया। – Idaho

+2

बहुत अच्छा जवाब! क्या उन चेतावनियों को फ़ाइल में रीडायरेक्ट करने का कोई तरीका है? – jsmedmar

+1

@jsmedmar, क्या आपने [** - डब्ल्यू **] (http://www.sphinx-doc.org/en/stable/invocation.html#cmdoption-sphinx-build-w) विकल्प का उपयोग करने का प्रयास किया है? – mzjn

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

  • कोई संबंधित समस्या नहीं^_^