Sfenks: Bir modüldeki işlevlerin listesi

Question

Çoğunlukla işlevleri ve birkaç sınıfı içeren bazı python modülleri var. Her biri ayrı bir noktada sfenks-autodoc kullanılarak belgelenmiştir. Ne yapmak istiyorum örneğin mymodule.py ait

def first(): 
    'First function' 

def second(): 
    'Second function' 

yani, her sayfanın üst kısmında modülünün içindekiler tablosu veya liste oluşturmak için Ve mymodule.rst

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

:create_page_contents_list: 

Members 
------- 

.. automodule:: mymodule 
    :members: 

olduğunu :create_page_contents_list: nasıl

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

first 
second 

Members 
------- 

first() 
    First function 

second() 
    Second function 

soru:

Sonra çıktı bu gibi görünmelidir. Bir TOC kullanmaya bakıyorum ama her bir öğe için elle bir giriş oluşturmanız gerekecek gibi görünüyor. Aynı zamanda autosummary'a da baktım, ama yine de üyeleri listelemem gerekiyor. Bunu otomatikleştirmek için herhangi bir öneriniz var mı? Üçüncü taraf uzantılarından kaçınmayı tercih ederim.

Answer 1

autosummary extension gibi bir şey isteyebilirsiniz. Gerçek autosummary uzantısı, ne istediğinizi tam olarak yapmayacaktır.

Eğer modülün içeriğini otomatik olarak algılamaya Otomatik Özet uzatmak nasıl bir örnek Bu durumda onun kullanımıyla ilgili bir örnek verebilir in this answer