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文件中，如文档here所述。但是，我必须列出我的模块上的每个函数才能使其工作。我认为autosummary扩展可以为我做这个。

sphinx auto summary：创建模块的摘要

0 个答案: