स्फिंक्स: मॉड्यूल

Question

में फ़ंक्शंस की सूची में मेरे पास कुछ पायथन मॉड्यूल हैं जिनमें अधिकांश फ़ंक्शंस और कुछ कक्षाएं हैं। प्रत्येक को एक अलग आरएसटी में स्फिंक्स-ऑटोडोक का उपयोग करके दस्तावेज किया जाता है। मुझे क्या करना चाहते हैं प्रत्येक पेज के शीर्ष पर मॉड्यूल के विषय सूची या सूची बनाने के लिए है, तो उदाहरण के लिए, mymodule.py की

def first(): 
    'First function' 

def second(): 
    'Second function' 

है और mymodule.rst

Page Contents 
------------- 

:create_page_contents_list: 

Members 
------- 

.. automodule:: mymodule 
    :members: 

है

Page Contents 
------------- 

first 
second 

Members 
------- 

first() 
    First function 

second() 
    Second function 

सवाल :create_page_contents_list: कैसे करना है:

फिर उत्पादन कुछ इस तरह दिखना चाहिए। मुझे एक टीओसी का उपयोग करने पर एक नज़र है, लेकिन ऐसा लगता है कि मुझे प्रत्येक आइटम के लिए मैन्युअल रूप से एक प्रविष्टि बनाने की आवश्यकता होगी। मैंने ऑटोसमेटरी को भी देखा है, लेकिन मुझे अभी भी सदस्यों को सूचीबद्ध करने की आवश्यकता है। इसे स्वचालित करने के लिए कोई सुझाव? मैं तीसरे पक्ष के एक्सटेंशन से बचने के बजाय।

Answer 1

शायद आप autosummary extension जैसे कुछ चाहते हैं। असली ऑटोसमैमर एक्सटेंशन जो भी आप चाहते हैं वह काफी नहीं करेगा।

कैसे आप मॉड्यूल की सामग्री ऑटो का पता लगाने के autosummary का विस्तार हो सकता है का एक उदाहरण in this answer