2010-09-02 10 views
22

मैं एक लाइब्रेरी दस्तावेज कर रहा हूं जिसमें पाइथन घटक और एक जावास्क्रिप्ट घटक है। समग्र उपयोगकर्ता प्रलेखन, और पायथन एपीआई दस्तावेज पुन: संरचित पाठ में हैं, स्फिंक्स के साथ संसाधित। जावास्क्रिप्ट एपीआई jsdoc में है और jsdoc-toolkit के साथ संसाधित है। प्रिंसिपल आउटपुट प्रारूप एचटीएमएल होगा। मैं रीस्ट, स्फिंक्स और जेएसडोक के लिए नया हूं।पुन: संरचित पाठ में रिश्तेदार लिंक डालें

मैंने एक बिल्ड सिस्टम स्थापित किया है, इसलिए सभी जेनरेट किए गए HTML पृष्ठ एक निर्देशिका पेड़ में डाले गए हैं। अब मुझे जेनरेट किए गए जावास्क्रिप्ट दस्तावेज़ों के लिंक के मुख्य पृष्ठ (आरएसटी से उत्पन्न) में डालने की आवश्यकता है। यह एक सापेक्ष लिंक होना चाहिए, क्योंकि दस्तावेज़ विभिन्न प्रतिष्ठानों पर विभिन्न स्थानों पर स्थित हो सकते हैं। रीस्ट स्वचालित रूप से एक पूर्ण यूआरएल पार्स करेगा, लेकिन मैं यह नहीं समझ सकता कि इसे रिश्तेदार लिंक कैसे डाला जाए। :ref: और :doc: जैसे निर्माण मदद नहीं करते हैं, क्योंकि वे लक्ष्य को पुन: स्थापित करने की अपेक्षा करते हैं।

कोई विचार?

उत्तर

28

यह पता लगाया। निम्नलिखित आवेषण दस्तावेज़ js/index.html के एक रिश्तेदार संदर्भ:

`Javascript API <js/index.html>`_ 
+0

जब तक आप अभी भी एक बेहतर जवाब के लिए देख रहे हैं, तो आप अपने जवाब को स्वीकार करना चाहिए। इस तरह लोग जो खोज में आपका प्रश्न पाते हैं, वे देख सकते हैं कि इसका सही जवाब है। –

+0

भूल गए कि मैंने अभी तक स्वीकार नहीं किया था। –

+0

यह संदर्भ उपयोगी होगा: http://hyperpolyglot.org/lightweight-markup – Javier