चेतावनी: दस्तावेज़ शामिल फ़ाइल

Question

मैं चेतावनी हो रही है के लिए किसी भी toctree में शामिल नहीं है:

WARNING: document isn't included in any toctree 

फ़ाइलें जो दस्तावेज़ में मौजूद हैं, क्योंकि वे स्पष्ट रूप से शामिल किया गया है के लिए। के रूप में,

.. toctree:: 
    :maxdepth: 2 

    pages/0010-foo 
    pages/0020-bar 

0020-bar.rst, मैं विशेष रूप से अन्य फ़ाइलों की एक संख्या शामिल कर रहा हूँ फ़ाइल में:: तो मैं अनुक्रमणिका फ़ाइल है

.. contents:: :local: 

.. include:: /pages/reference-architecture/technical-considerations/0070-baz.rst 

लेकिन जब मैं इस परियोजना का निर्माण , मैं अभी भी एक चेतावनी है कि 0070-baz.rst किसी भी toctree में नहीं है, के रूप में मिलती है:

/home/nick/Documents/myProject/docs/pages/reference-architecture/technical-considerations/0070-baz.rst:: WARNING: document isn't included in any toctree 

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

धन्यवाद!

Answer 1

स्फिंक्स इस बारे में शिकायत करेगा कि फ़ाइल शामिल है या नहीं।

हालांकि, आप विशेष रूप से exclude_patterns कॉन्फ़िगरेशन मान का उपयोग करके फ़ाइलों को बहिष्कृत कर सकते हैं। आप अलग-अलग फ़ाइलों, निर्देशिका, या उपयोग फ़ाइल पैटर्न ग्लोबिंग फ़ाइलों के समूह इस तरह से मैच के लिए बाहर कर सकते हैं

exclude_patterns = ['pages/reference-architecture', some/other/file.txt] 

:

तो अपने मामले के लिए आप की तरह कुछ कोशिश कर सकते हैं।

Answer 2

इंडेंटेशन काम किया:

toctree:: 
    :maxdepth: 2 
     hello <h.rst> 
     abc <your.rst> 

Answer 3

आप केवल ..include:: को किसी अन्य दस्तावेज़ में किसी दस्तावेज़ चाहते हैं, यह किसी भी toctree में प्रदर्शित किए बिना।

चेतावनी से छुटकारा पाने के लिए अपने दस्तावेज़ के शीर्ष पर :orphan: जोड़ें।

यह एक फ़ाइल चौड़ा मेटाडाटा विकल्प है, यहाँ और अधिक देखें:

http://www.sphinx-doc.org/en/1.4.8/markup/misc.html#metadata