1

我将 Sphinx 与 autodoc 和 numpydoc 扩展一起使用来生成一个非常复杂的包的文档。我在自动生成中遇到了一个问题：

假设我有一个包含两个模块calculator.py和math.py.

在 内部calculator.py，我定义了一个类，它将math.py模块中的一个函数分配为标准变量：

class Calculation(object):
    def some_calculation(some_variable,calculate=math.multiplication)

在我的 sphinx 文档中，我使用类似于

.. autoclass:: some_package.calculator.Calculation
    :members:

在我的文档中，该函数现在显示为一个指针，而不是名称：

some_calculation(some_variable,calculate=<function multiplication at 0x2b8882ef7f50>)

这是什么东西，我可以在 Sphinx 配置中进行更改，以便我的输出如下所示：

some_calculation(some_variable,calculate=math.multiplication)

?

4

1 回答 1

1

some_calculation在第一行是您想要的签名的位置添加一个文档字符串：

class Calculation(object):
    def some_calculation(self, some_variable, calculate=math.multiplication):
        """some_calculation(some_variable, calculate=math.multiplication)

           More text...
        """
        ...

参考：http ://sphinx-doc.org/ext/autodoc.html#confval-autodoc_docstring_signature

于 2014-08-06T16:58:26.060 回答