热门文章
 当前位置：技术文章 > 编程面试题 >

如何使用autodoc覆盖Sphinx中的构造函数参数？

问题内容：

假设我有一个这样的课程：

class MyClass(object):
    """ Summary docs for my class.

    Extended documentation for my class.
    """

    def __init__(self, *args):
        self.values = np.asarray(args)

如果我使用Sphinx及其autodoc扩展来记录此类，则如下所示：

.. automodule:: mymodule
   :members:

…构造函数签名显示为 MyClass(*args) 。我宁愿重写它并将其记录为 MyClass(first, second, third) 。

如果这是一个函数，我可以覆盖文档字符串第一行中的签名。但是该技巧似乎不适用于类文档字符串。那么如何覆盖构造函数签名？


问题答案：

我认为最适合您的选择是执行以下操作：

.. automodule:: mymodule
    :members:
    :exclude-members: MyClass

    .. autoclass:: MyClass(first, second, third)

MyClass将具有被覆盖的参数，并且的其他成员mymodule将被自动记录。您需要排除MyClass使用，:exclude- members:因为它将被包含两次。我认为这是目前最简单的解决方案。