python-sphinx पर टैग किए गए जवाब

मुझे RST से नफरत है लेकिन स्फिंक्स से प्यार है। वहाँ एक तरीका है कि स्फिंक्स reStructuredText के बजाय markdown पढ़ता है?

212 python  markdown  python-sphinx 

मैं स्फिंक्स का उपयोग करने के लिए पायथन में 5,000+ लाइन परियोजना के दस्तावेज का उपयोग कर रहा हूं। इसमें लगभग 7 बेस मॉड्यूल हैं। जहां तक ​​मुझे पता है, ऑटोडोक का उपयोग करने के लिए मुझे अपनी परियोजना में प्रत्येक फ़ाइल के लिए इस तरह कोड लिखना होगा: .. …

149 python  python-sphinx  autodoc 

एक ही दस्तावेज़ीकरण सेट में किसी अन्य पृष्ठ में किसी सब-हेडर या एंकर के लिए एक reST / Sphinx पृष्ठ में क्रॉस-संदर्भ कैसे डालें?

110 python-sphinx  restructuredtext 

स्फिंक्स डिफ़ॉल्ट रूप से __in __ (स्व) के लिए डॉक्स उत्पन्न नहीं करता है। मैंने निम्नलिखित कोशिश की है: .. automodule:: mymodule :members: तथा ..autoclass:: MyClass :members: Conf.py में, निम्नलिखित को सेट करना केवल __init __ को जोड़ता है (स्व) वर्ग docstring के लिए docstring ( Sphinx autodoc दस्तावेज़ीकरण इस …

107 python  python-sphinx  autodoc 

मैं स्फिंक्स के साथ शुरुआत करने की कोशिश कर रहा हूं और लगता है कि अथक समस्याएं हैं। कमान: docs/sphinx-quickstart मैं सभी सवालों के जवाब देता हूं और सब कुछ ठीक चलता है। कमान: docs/ls सब कुछ सामान्य लग रहा है। परिणाम:build Makefile source कमान: sphinx-build -d build/doctrees source build/html …

104 python  python-sphinx  autodoc 

मैं अपने पायथन मॉड्यूल के लिए एपीआई प्रलेखन उत्पन्न करने के लिए स्फिंक्स और ऑटोडोक प्लगइन का उपयोग कर रहा हूं । जब तक मैं देख सकता हूं कि विशिष्ट मापदंडों को कैसे अच्छी तरह से प्रलेखित किया जाता है, तो मैं इस बात का उदाहरण नहीं पा सकता हूं …

99 python  python-sphinx  autodoc 

बंद हो गया । इस प्रश्न पर अधिक ध्यान देने की आवश्यकता है । यह वर्तमान में उत्तर स्वीकार नहीं कर रहा है। इस प्रश्न को सुधारना चाहते हैं? प्रश्न को अपडेट करें ताकि यह इस पोस्ट को संपादित करके केवल एक समस्या पर केंद्रित हो । 2 साल पहले …

94 python  documentation  doxygen  docstring  python-sphinx 

मैं निम्नलिखित कोड का उपयोग करके एक अच्छी तरह से नेस्टेड सूची बनाने की कोशिश कर रहा हूं ( Sphinx और docutils डॉक्स के बाद): 1. X a. U b. V c. W 2. Y 3. Z मुझे उम्मीद है कि इसके परिणाम दो हैं OLलेकिन मुझे इसके बदले निम्न …

90 markup  restructuredtext  python-sphinx 

मैं एक गैर-पायथन परियोजना के दस्तावेज के लिए स्फिंक्स का उपयोग कर रहा हूं। मैं उस मॉड्यूल को दस्तावेज़ करने के लिए फ़ाइलों ./docवाले प्रत्येक सबमॉड्यूल में फ़ोल्डर वितरित करना चाहता हूं submodule_name.rst। मैं तो पूरी डिजाइन के लिए एक युक्ति बनाने के लिए उन फ़ाइलों को मास्टर पदानुक्रम में …

90 python  python-sphinx 

मैं अपनी कक्षा में एक विधि के लिंक को उसी कक्षा की दूसरी विधि के docstring के भीतर जोड़ना चाहता हूं। मैं चाहता हूं कि स्फिंक्स और अधिमानतः स्पाईडर और अन्य पायथन आईडीई में काम करने के लिए लिंक। मैंने कई विकल्पों की कोशिश की और केवल एक ही पाया …

90 python  python-sphinx  spyder 

आप reStructuredText में एक निरूपित लिंक के भीतर पाठ को कैसे प्रारूपित करते हैं? विशेष रूप से, मैं अपने rst से निम्न HTML उत्पन्न करना चाहता हूं: <a href="http://docs.python.org/library/optparse.html"><tt>optparse.OptionParser</tt> documentation documentation</a> परिणाम इस तरह दिखना चाहिए: optparse.OptionParser प्रलेखन जहां "Optparse.OptionParser" भाग निश्चित-चौड़ाई वाले फ़ॉन्ट में है। मैंने कोशिश की ```optparse.OptionParser`` …

82 python-sphinx  restructuredtext 

रीड-द-डॉक्स पर स्फिंक्स डॉक्स का निर्माण निम्नलिखित त्रुटि के साथ विफल होता है (नीचे पूर्ण लॉग): ImportError: cannot import name 'PackageFinder' from 'pip._internal.index' (/home/docs/checkouts/readthedocs.org/user_builds/cascade-python/envs/latest/lib/python3.7/site-packages/pip/_internal/index/__init__.py) क्या मैंने कुछ गलत किया है या क्या यह डॉक्स में एक बग है? स्फिंक्स डॉक्स का एक स्थानीय निर्माण ठीक चलता है। रीड-ए-डॉक्स पर पूर्ण …

25 python  python-sphinx  read-the-docs 

कृपया फ़ाइल डाउनलोड करें simple.7zऔर अपने स्फिंक्स में उन समस्याओं को पुन: उत्पन्न करने के लिए स्थापित करें जिन्हें मैंने यहां वर्णित किया है, इसे पुन: उत्पन्न करने के लिए, आप चला सकते हैं: make clean make html डाउनलोड और मुद्दों को पुन: पेश करने के लिए अपने स्फिंक्स में …

14 python  python-sphinx