स्फिंक्स टक्ट्री निर्देश में बाहरी सापेक्ष लिंक

Question

मैं अपने दस्तावेज़ बनाने के लिए Sphinx का उपयोग कर रहा हूं। मैं एपीआई संदर्भ के लिए अन्य उपकरण का उपयोग कर रहा हूँ। मेरे पास निर्देशिका में मेरे दस्तावेज़ हैं और इसके अंदर निर्देशिका नाम एपीआई में एपीआई संदर्भ है।

मैं प्रलेखन से एपीआई संदर्भ में एक लिंक चाहता हूं। मैं अपने toctree लिंक तो एक लिंक जोड़ कर सकती हूं:

.. toctree:: 
    :maxdepth: 1 

    starting 
    glossary 
    main-use-case-flow 
    API Reference <http://www.example.com/lib/ios/0.1.0/api/> 

समस्या मैं एक पूर्ण पथ डाल करने के लिए नहीं करना चाहती है, मैं सिर्फ रिश्तेदार पथ रखना चाहते हैं api/

कैसे कर सकते हैं मैंने सापेक्ष पथ का उपयोग करके बाह्य संसाधन का एक लिंक रखा और पूर्ण पथ नहीं?

Answer 1

निम्न सिंटैक्स मेरे लिए काम करता है:

`Page Title <../relative/path.html>` 

Answer 2

मैं hackiest ऐसा करना संभव तरीकों में से एक मिल गया। असल में स्फिंक्स या तो किसी दस्तावेज़ या पथ के पथ को अनुमति देता है जिसके लिए http:// की आवश्यकता होती है। यह पता चलता है कि वे आपके लिंक को सत्यापित करने के लिए वास्तव में http:// देख रहे हैं।

*WARNING: toctree contains reference to nonexisting document u'downloads'* 
Downloads <../downloads> 

लेकिन अगर आप कार्य करें:

Downloads <../downloads#http://> 

कोई चेतावनी! इसका मतलब यह है कि जब उपयोगकर्ता आपके लिंक पर क्लिक करता है, तो यह आपके पृष्ठ लिंक पर http://खंड या एंकर नाम देता है। यदि यह आपके एचटीएमएल में एक वैध नाम एंकर नहीं है, तो यह आपके पृष्ठ पर कुछ भी नहीं करेगा (जब तक कि आपके पृष्ठ में कुछ जावास्क्रिप्ट नहीं है जो नामांकित एंकर के साथ कुछ करता है)।

Answer 3

मुझे इस समस्या का सामना करना पड़ा जब मैंने अपने toctree पर (जेनरेट किए गए) javadocs के लिंक जोड़ने का प्रयास किया।

मेरा समाधान toctree की आवश्यकताओं को पूरा करने के लिए मेरे स्रोत पेड़ के उचित स्थान पर एक फोनी index.rst बनाना था। मुझे पता चला जाली index.rst फ़ाइल एक शीर्षक शामिल होना चाहिए, इसलिए मेरे फ़ाइल इस तरह देखा:

======================= 
Java API (All Packages) 
======================= 

जब आप make चलाने के लिए, इस फाइल को अपने निर्माण निर्देशिका, _build/html (या जो भी) में नकल हो जाता है।

और फिर इसे पुन: संरचित पाठ प्रक्रिया के बाद वास्तविक फ़ाइल के साथ प्रतिस्थापित करें।

Answer 4

स्फिंक्स के वर्तमान संस्करण में आप सिर्फ रख सकते हैं

.. toctree:: 

    Title <http://LINK> 

और यह काम करेंगे।