Sphinx autosummary：创建模块的摘要

Question

我在让 sphinx 创建模块汇总表时遇到问题。我已添加sphinx.ext.autosummary到我的conf.py文件中并且正在使用numpydoc. Sphinx 似乎为类上的属性和方法创建汇总表，但它不会为包含该类的模块创建汇总表。

我创建了一个最小工作示例（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扩展可以为我做到这一点。