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

Question

假设我有这样一个类:

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

    Extended documentation for my class.
    """

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

如果我使用带有 autodoc 扩展的 Sphinx 来记录这个类，就像这样:

.. automodule:: mymodule
   :members:

...构造函数签名显示为 MyClass(*args)。我宁愿覆盖它并将其记录为，比如说，MyClass(first, second, third)。

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

Answer 1

我认为对你来说最好的选择是做这样的事情:

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

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

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