2010-09-21 11 views
8

मैं उन शब्दों के लिए परिभाषाओं के साथ "शब्दावली" अनुभाग बनाना चाहता हूं, जिनका उपयोग मैं इस शब्दावली खंड में शर्तों का उपयोग करता हूं, एक लिंक बनाया गया है जो परिभाषा को इंगित करता है।स्फिंक्स में, मैं बड़े पैमाने पर ओवरहेड के बिना एक लिंक करने योग्य "शब्दावली" अनुभाग कैसे बना सकता हूं?

वर्तमान में, सबसे अच्छा मैं सोच सकते है:

''' This is a usage of the word |flavor|.''' 

मैं बहुत बोझिल होने के लिए ऊपर वाक्य रचना लगता है:

.. |flavor| replace:: `:ref:flavor` 

.. _flavor: 

flavor 
------ 
blah blah blah 

फिर बाद में, अन्य पाठ में मैं क्या करना है। मुझे लगता है मैं अभी तक स्क्रिप्टिंग या करने के लिए m4 की एक और परत इस्तेमाल कर सकते हैं इस वाक्य को स्वत: जनरेट पता है, लेकिन मैं वहाँ एक बेहतर तरीका है आशा करती हूं कि ..

उत्तर

20

नहीं बहुत अलग है, लेकिन आप उपयोग कर सकते हैं:

.. शब्दावली ::

इस निर्देश में नियम और परिभाषाओं के साथ एक पुनर्नवीनीकरण सूची होनी चाहिए। परिभाषाओं को फिर 'शब्द' भूमिका के साथ संदर्भित किया जाएगा।

: अवधि: शब्दकोष में एक शब्द के लिए

संदर्भ। शब्दावली शब्दावली निर्देश का उपयोग करके बनाई गई है जिसमें परिभाषा सूची और परिभाषाओं के साथ परिभाषा सूची है। यह मार्कअप शब्द के समान फ़ाइल में होना आवश्यक नहीं है, उदाहरण के लिए पाइथन डॉक्स में glossary.rst फ़ाइल में एक वैश्विक शब्दावली है।

यदि आप किसी शब्दावली में समझाया गया शब्द नहीं उपयोग करते हैं, तो आपको निर्माण के दौरान चेतावनी मिलेगी।

[official sphinx documentation]

+0

से चिपकाया मुझे लगता है मैं कोश से सलाह ली जब स्फिंक्स डॉक्स खोज "शब्दावली" के लिए एक अलग शब्द खोजने के लिए should'a। धन्यवाद eolo999। –