Sphinx：モジュール内の関数のリスト

Question

ほとんどの関数といくつかのクラスを含むいくつかのpythonモジュールがあります。それぞれは別の最初にsphinx-autodocを使用して文書化されています。私は何をしたい例えば、mymodule.pyの

def first(): 
    'First function' 

def second(): 
    'Second function' 

そしてmymodule.rst

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

:create_page_contents_list: 

Members 
------- 

.. automodule:: mymodule 
    :members: 

であるので、各ページの上部にあるモジュールの内容のテーブルまたはリストを作成することです :create_page_contents_list:を行う方法

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

first 
second 

Members 
------- 

first() 
    First function 

second() 
    Second function 

質問：

その後出力は次のようになります。私は目次を使用して見ているが、私は手動で各項目のエントリを作成する必要があるようだ。私は自動サマリーも見ましたが、まだメンバーを列挙する必要があります。これを自動化するための提案はありますか？私はむしろサードパーティの拡張機能を避けるだろう。

Answer 1

おそらくのようなものがのautosummary extensionのようになります。しかし、実際のautosummaryの拡張は、あなたが望むものをまったく行いません。

あなたはモジュールの内容を自動検出し、自動サマリーを拡張する方法の例は、in this answer