मेरे पास ऐसा कुछ है:
.. toctree::
:maxdepth: 2
:caption: Contents:
:hidden:
:glob:
docs
frontend
backend
tools/*
मैं चाहता हूं कि tools निर्देशिका में पाए गए सभी दस्तावेज़ एक विस्तार योग्य साइडबार TOC प्रविष्टि में संक्षिप्त हो जाएं। संभव होना चाहिए, लेकिन मुझे कोई सुराग नहीं मिल रहा है।
मैं sphinx_rtd_theme का उपयोग करता हूं।
इसे दूसरे तरीके से रखने के लिए: मान लीजिए कि मेरे पास इस तरह का एक बहुत लंबा दस्तावेज़ है (tools.rst):
Section 1
*********
Subsection 1
============
Subsection 2
============
Subsection 3
============
मैं इसे उपखंड द्वारा कैसे विभाजित कर सकता हूं और दस्तावेज़ संरचना को संरक्षित करने के लिए, बिना शामिल किए, जो वैसे भी स्फिंक्स के साथ अच्छी तरह से नहीं बैठता है।
1 उत्तर
source/index.rst:
.. toctree::
:maxdepth: 2
:caption: Contents:
:glob:
tools/_tools
docs
frontend
backend
tmp/*
पुराना source/tools/_tools.rst:
Notes on tools
**************
.. include:: black.rst
.. include:: docker.rst
.. include:: git_hooks.rst
.. include:: github_webhooks.rst
.. include:: mypy.rst
.. include:: pipm.rst
.. include:: poetry.rst
.. include:: sphinx.rst
.. include:: uvicorn.rst
नया source/tools/_tools.rst:
Notes on tools
**************
.. toctree::
:maxdepth: 2
:glob:
*
नया वाला बिल्कुल पुराने जैसा दिखता है, और अधिक बहुमुखी है और बहुत साफ है।
संबंधित सवाल
जुड़े हुए प्रश्न
नए सवाल
python-sphinx
स्फिंक्स एक उपकरण है जो बुद्धिमान और सुंदर प्रलेखन बनाने में आसान बनाता है। स्फिंक्स विशेष रूप से पायथन प्रलेखन के लिए उपयुक्त है, लेकिन यह एक सामान्य-उद्देश्य वाला उपकरण है जिसका उपयोग किसी भी चीज को दस्तावेज करने के लिए किया जा सकता है।
tools/example.rstहै? क्या आप कह रहे हैं कि उपखंड साइडबार नेविगेशन में प्रकट नहीं होते हैं? क्या आपने:maxdepth: 3की कोशिश की?tools.rstहै जिसमें मेरीsourceनिर्देशिका में एक अनुभाग शीर्षक है; मैं इसेsource/toolsऔर में विभाजित करना चाहता हूं (एक एकल अनुभाग शीर्षक)। मैंने इसका प्रबंधन नहीं किया।toctreeमें न तोtools.rstऔर न हीtoolsहै। यही कारण है कि यह नेविगेशन में दिखाई नहीं देता है।toctreeसूची में यह दिखाई देने के लिए आपके पास उनमें से एक होना चाहिए।index.rstहै। बेशक,tools.rstशुरू मेंindex.rstमें मौजूद था। मैंने इसे विभाजित करने और इसेsource/toolsऔर में स्थानांतरित करने और उपस्थिति और पदानुक्रम को संरक्षित करने का प्रबंधन नहीं किया। धारा अब उपखंडों की जड़ नहीं है। निर्देश शामिल करें, वैसे, काम करते हैं, लेकिन वे बदसूरत और बोझिल हैं।