स्फिंक्स दस्तावेज़ जेनरेटर में, क्या मैं इंडेक्स में एक संपूर्ण पैकेज (रिकर्सिवली) जोड़ सकता हूं?

Question

मैं अपने पैकेज के लिए प्रलेखन जेनरेट करना चाहता हूं। परियोजना में प्रत्येक फाइल में व्यापक दस्तावेज शामिल हैं। क्या मेरे पूरे प्रोजेक्ट को ड्यूमेटेशन इंडेक्स में जल्दी से जोड़ने का कोई तरीका है?

मैं पूरी परियोजना के लिए कुछ दस्तावेज स्वचालित रूप से कम से कम काम के साथ उत्पन्न करना चाहता हूं। मैं index.rst के लिए निम्न जोड़कर प्रारंभ:

.. automodule:: mymodulename 
    :members: 

सब किया है लगता है __init__.py फ़ाइल (सिर्फ एक docstring) में दस्तावेज़ elenments है - वहाँ किसी भी तरह से मैं इसे और सब कुछ दस्तावेज़ कर सकते हैं? मैं अपने पैकेज में परिभाषित बिल्कुल सही सब कुछ जोड़ना चाहता हूं और पैकेज में प्रत्येक एकल वर्ग, स्थिर, फ़ंक्शन (आदि) उचित सूचकांक में जोड़ा जाना चाहिए।

क्या यह किया जा सकता है?

Answer 1

आप sphinx-apidoc का उपयोग कर सकते हैं।
official documentation से: sphinx-apidoc स्फिंक्स स्रोतों की स्वचालित पीढ़ी के लिए एक उपकरण है, जो ऑटोडोक एक्सटेंशन का उपयोग करके, अन्य स्वचालित एपीआई दस्तावेज़ दस्तावेजों की शैली में एक संपूर्ण पैकेज दस्तावेज करता है।

एक के उपयोग का उदाहरण (अपनी परियोजना रूट निर्देशिका से) हो सकता है:

$ sphinx-apidoc . --full -o doc -H 'MyProject' -A 'MyName' -V '1.0' 

एक doc निर्देशिका सब कुछ अंदर तैयार के साथ बनाया जा जाएगा।
आप ऑटो-जेनरेट conf.py फ़ाइल को संपादित करने के अपने दस्तावेज़ों की सेटिंग्स को भी समायोजित कर सकते हैं।

अन्य उपयोगी जानकारी similar question posted here में मिल सकती है।