2011-05-25 5 views
8

मैं प्रोजेक्ट को दस्तावेज करने के लिए स्फिंक्स का उपयोग करने की कोशिश कर रहा हूं, लेकिन मैं यह नहीं समझ सकता कि इंटर्सफिनक्स का उपयोग कैसे करें। मैं इस लाइन का उपयोग करें:मैं मानक लाइब्रेरी दस्तावेज में एक मनमानी विधि के लिए एक intersphinx लिंक कैसे डाल सकता हूं?

:py:meth:`math.sin` 

लिंक जोड़ने के लिए है, लेकिन उत्पादन में, यह एक कड़ी के रूप में बोल्ड दिखाई देता है,। हालांकि कि लाइन काम नहीं करता है, दोनों निम्न कार्य करें:

:py:meth:`dict.items` 
:py:class:`zipfile.ZipFile` 

conf.py फ़ाइल में मेरे intersphinx_mapping मूल्य है:

intersphinx_mapping = {'python':('http://docs.python.org/2.7', None)} 

उत्तर

4

आप intersphinx के लिए दस्तावेज़ पढ़े हैं? यहाँ crossreference

+1

मैंने इंटर्फ़िंक्स के लिए प्रलेखन पढ़ा है, लेकिन मुझे कुछ भी नहीं दिख रहा है जो मेरी मदद करता है ... मैंने पोस्ट को और विवरण के साथ संपादित किया है। –

+0

हां, मैंने उस पृष्ठ पर सभी निर्देशों का पालन किया। –

+0

वास्तव में मेरे लिए काम नहीं करता है, मुझे यह दिलचस्प पोस्ट मिला है कि मैं अभी पढ़ रहा हूं http://comments.gmane.org/gmane.comp.python.sphinx.devel/4283 –

8

:py:meth: निर्माणों के बारे में

*** 
TRY 
*** 

My try 
====== 

sin 
:py:func:`math.cos` 

pop 
:py:meth:`dict.pop` 

dict 
:py:meth:`dict.items` 

zipfile 
:py:class:`zipfile.ZipFile` 

पढ़ें :py:func: होना चाहिए:

संपादित

यह इस का उपयोग कर काम करने के लिए मिला है। असल में, कोई मान्य domain का उपयोग किया जा सकता है।

+0

सोचें कि हमने इसे एक ही लिंक, रोचक अभ्यास का उपयोग करके एक साथ हल किया है ;-) –

+1

हां, मैंने देखा है कि स्फिंक्स दस्तावेज़ों के कुछ हिस्सों में बहुत बुरा है। –

+0

': py: func:' काम करता है, लेकिन यह ध्यान दिया जाना चाहिए कि [intersphinx] (http://sphinx-doc.org/latest/ext/intersphinx.html) पहले सेट अप किया जाना चाहिए! –

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

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