python - Sphinx autosummary: モジュールの概要を作成します

Question

sphinx でモジュールの要約テーブルを作成するのに問題があります。ファイルに追加sphinx.ext.autosummaryし、使用しています。Sphinx は、クラスの属性とメソッドの要約テーブルを作成するようですが、クラスを含むモジュールの要約テーブルを作成しません。conf.pynumpydoc

これをテストするために、最小限の作業例 (MWE) を作成しました。MWE プロジェクトには、__init__.pyインポートする と がありgeneric_moduleます。の内容は次のgeneric_moduleとおりです。

def foo(a, b):
    """
    Adds a + b
    """
    return(a+b)

def bar(a, b):
    """
    Subtracts a + b
    """
    return(a-b)

class onetwo(object):
    """
    Adds 1 or 2
    """
    def __init__(self):
        self.whatever = 1

    def one(self, a):
        """
        Adds one to a
        """
        return(a + 1)

    def two(self,a):
        """
        Adds two o a
        """
        return(a + 2)

Sphinx 自動ドキュメントfoo、bar、およびonetwo. また、 のメソッドの優れた要約も作成されonetwoます。ただし、 のページの上部に要約テーブルは作成されませんgeneric_module。

ここ.. autosummary::に記載されているように、自分のgeneric_module.rstファイルに追加できることを知っています。ただし、モジュールを機能させるには、モジュールのすべての関数をリストする必要があります。私は拡張機能が私のためにこれを行うことができると思います.autosummary