9
संभव डुप्लिकेट:
Sphinx — combining automodule and autoclassपायथन: स्फिंक्स: स्फिंक्स दस्तावेज़ में स्वचालित रूप से सभी वर्गों, विधियों और कार्यों को कैसे शामिल किया जाए?
मैं स्फिंक्स का उपयोग कर कई हजार वर्गों से युक्त एक परियोजना के लिए एक एचटीएमएल प्रलेखन बनाने का प्रयास करें और यह autodoc प्लगइन है। स्फिंक्स-एपिडोक अद्भुत आरएसटी-फाइलें बनाता है, लेकिन ऑटोक्लास और ऑटोमाइड्स के स्वचालित निर्माण की कमी है।
क्या स्पिंक्स में दस्तावेज में सभी चर, कार्यों, कक्षाओं और सजावट को स्वत: शामिल करने के लिए कोई तरीका/कमांड/उपयोगिता है?
एक पहला-फ़ाइल से कुछ नमूना कोड:
tagger Package
=================
:mod:`tagger` Package
------------------------
.. automodule:: project.tagger
:members:
:mod:`client` Module
--------------------
.. automodule:: project.analyzers.tagger.client
:members:
क्या आपने पहले ही ['autodoc' एक्सटेंशन] (http://sphinx-doc.org/ext/autodoc.html#module-sphinx.ext.autodoc) की जांच की है? –
autodoc विस्तार conf.py में जोड़ा जाता है: एक्सटेंशन = [ 'sphinx.ext.autodoc', 'sphinx.ext.viewcode'] स्फिंक्स सभी मॉड्यूल का पता लगाता है, लेकिन यह वर्गों और यह तरीकों की सूची नहीं है। – Jon
उपरोक्त ऑटोोडोक एक्सटेंशन के अनुसार 'दस्तावेज़ों के बिना सदस्यों को छोड़ दिया जाएगा, जब तक कि आप अंडर-सदस्य ध्वज विकल्प' – intotecho