प्रत्येक पृष्ठ के साइडबार में टक्ट्री को कैसे शामिल करें

Question

मैं स्फिंक्स में एचटीएमएल दस्तावेज उत्पन्न कर रहा हूं।

मैं अपने दस्तावेज़ में प्रत्येक HTML पृष्ठों के लिए साइडबार को कैसे संशोधित करूं ताकि उनमें टक्ट्री शामिल हो? डिफ़ॉल्ट रूप से टक्ट्री केवल master_doc पृष्ठ में प्रदर्शित होता है, और केवल साइडबार के बजाय मुख्य क्षेत्र में प्रदर्शित होता है।

क्या ऐसा करने का कोई आसान तरीका है? मैं जेनरेट किए गए दस्तावेज़ों को होस्ट करने के लिए रीडहेडॉक्स का उपयोग करूँगा, इसलिए मैं किसी भी तृतीय-पक्ष प्लगइन के उपयोग से बचना पसंद करूंगा, जब तक कि वे रीडहेडॉक्स पर भी उपलब्ध न हों।

Answer 1

आप conf.py में अपना एचटीएमएल साइडबार कस्टमाइज़ कर सकते हैं।

डिफ़ॉल्ट HTML साइडबार 4 टेम्पलेट्स के होते हैं:

['localtoc.html', 'relations.html', 'sourcelink.html', 'searchbox.html'] 

conf.py में आप इस तरह globaltoc.html को localtoc.html को बदल सकता है:

html_sidebars = { '**': ['globaltoc.html', 'relations.html', 'sourcelink.html', 'searchbox.html'], } 

लेकिन मैं इस करता है, तो यकीन नहीं है readthedocs पर काम करता है।

Answer 2

'globaltoc.html' सहित इसमें कोई कमी है कि यह आपके द्वारा देखे जा रहे पृष्ठ के लिए वैश्विक और स्थानीय दोनों टीओसी नहीं दिखाता है।

ऐसा लगता है कि दूसरों को इस सीमा के बारे में नाराज और एक एक्सटेंशन के बाद विकास के परिणामस्वरूप साइडबार में एक पूर्ण toc समर्थन करने के लिए कर रहे थे, चेकआउट: https://pypi.python.org/pypi/sphinxcontrib-fulltoc