2013-10-30 5 views
14

में किसी पृष्ठ अनुभाग से कैसे लिंक कर सकता हूं मेरे पास एक स्फिंक्स पेज के हिस्से के रूप में .. toctree है, जिसमें मेरे पैकेज में अन्य rst फ़ाइलों के सापेक्ष लिंक शामिल हैं। मैं पूर्ण पृष्ठ की बजाय किसी दिए गए पृष्ठ के उपखंड के लिए एक लिंक कैसे शामिल कर सकता हूं?मैं स्फिंक्स टक्ट्री

मैं

.. toctree:: 

    page#section 

पर एक चाकू ले लिया लेकिन वह काम नहीं किया। कोई मदद महान है।

उत्तर

3

ज्यादा hackery के बाद, मैं निम्नलिखित समाधान पर आए हैं, लेकिन मैं पहले यह लिखा होना चाहिए मेरा लक्ष्य था कि करने के लिए:

  1. सामग्री शरीर
  2. में प्रकट नहीं शीर्षक शीर्षक दिखाई देते हैं टीओसी

इसलिए मूल रूप से टीओसी से दस्तावेज़ के मनमाने ढंग से लेकिन अदृश्य भाग में लिंक करना।

मुझे स्पिन्क्सकंटिब PHPDomain के साथ प्रदान किए गए कुछ स्रोत कोड दस्तावेज़ों में विधियों से लिंक करने में सक्षम होने के लिए इसकी आवश्यकता है - ये विधियां स्वयं के अनुभाग लिंक उत्पन्न करती हैं, लेकिन डिफ़ॉल्ट रूप से TOC में शामिल नहीं होती हैं।

चरण 1:

जो इस जोड़ने कार्यक्षमता की जरूरत है अपने आरएसटी फ़ाइल के शीर्ष पर, इस तरह के रूप में एक नई भूमिका जोड़ें:

.. role:: hidden 
    :class: hidden 

चरण 2:

कहीं सामग्री में

, जैसे इस भूमिका का उपयोग करें:

:hidden:`My Arbitrary Location` 
""""""""""""""""""""""""""""""" 

चरण 3:

परियोजना के लिए नए CSS जोड़ (आमतौर पर _static में एक सीएसएस फ़ाइल जोड़ना, या कोई शैली पत्रक या ऐसा ही कुछ को परिभाषित करने के द्वारा किया - this देखें):

.rst-content .hidden { 
    display: none; 
} 

nav .hidden { 
    display: unset; 
} 

इस शीर्षक में छिपा होने के लिए बाध्य सामग्री, लेकिन टीओसी में दिखाया गया।

फिर, अन्य दस्तावेजों में आवश्यक भूमिका का पुन: उपयोग करें।


ध्यान रखें कि आपके लक्ष्य दस्तावेज़ में मनमाने ढंग से स्थानों से जोड़ने के लिए और अभी भी शीर्षकों सामग्री में दिखाई है, बस सीएसएस बदलने के बजाय उन्हें छिपाने के अपनी पसंद के शीर्षकों शैली है यदि।

+0

@ डंकन-माकलोद मुझे पता है कि यह थोड़ी देर हो गया है, लेकिन समीक्षा करने पर विचार करें? – Swader

0

जब टीओसी बनाते हैं, स्फिंक्स कॉन्फ़िगर किए गए पेड़ की गहराई के भीतर संदर्भित फ़ाइलों के सभी शीर्षलेखों और उपशीर्षक को शामिल करता है। तो आप बस एक शीर्षक के साथ पेज नहीं शुरू करते हैं और बात आप टीओसी ध्यान खींचना चाहते हैं, उदा .:

.. _my-rst-file: 
**You can use bold print here if you want. This will not appear in the ToC** 
.. rubric:: Or the "rubric" directive 

And here some more text, normal font weight. 

Here comes the heading that will appear in the ToC 
"""""""""""""""""""""""""""""""""""""""""""""""""" 
And so on... 

आप हमेशा की तरह टीओसी में पेज संदर्भ शामिल करने की जरूरत पर शीर्षक सम्मिलित कर सकते हैं। तो टीओसी में, आपके पास:

.. toctree:: 

    my_rst_file 

हमारे उदाहरण में, निर्माण परिणाम (HTML, PDF, जो कुछ भी) केवल टीओसी में Here comes the heading that will appear in the ToC के लिए एक संदर्भ होगा।

+0

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

+0

हां, शीर्षक में शीर्षक दिखाई देता है - उपरोक्त प्रश्न में यह बाधा नहीं है। हालांकि, आप अपने टेम्पलेट्स में सामान्य स्तर पर कुछ स्तरों के शीर्षलेखों को फिर से स्टाइल कर सकते हैं (हालांकि आप इसे हैकी के रूप में मान सकते हैं)। एक और कामकाज "वास्तविक" टीओसी के बजाय क्रॉस-रेफरेंस की सूची का उपयोग करना होगा। –

+0

सच है, बाधा वास्तव में सूचीबद्ध नहीं है। मैं जल्द ही अपना पूरा, कुछ हद तक जवाब पोस्ट करूंगा। – Swader

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