autodoc पर टैग किए गए जवाब

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

149 python  python-sphinx  autodoc 

स्फिंक्स डिफ़ॉल्ट रूप से __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