假设我有这样一个班级:
class MyClass(object):
""" Summary docs for my class.
Extended documentation for my class.
"""
def __init__(self, *args):
self.values = np.asarray(args)
如果我使用带有autodoc
扩展名的Sphinx来记录此类,如下所示:
…构造函数签名显示为MyClass(*args)
。我宁愿重写它并将其记录为,比如,MyClass(first, second, third)
。在
如果这是一个函数,我可以覆盖docstring第一行中的签名。但是这个技巧在类docstring上似乎不起作用。那么如何重写构造函数签名呢?在
我认为你最好的选择是这样做:
MyClass
将重写参数,mymodule
的其他成员将被自动记录。 您需要使用:exclude-members:
排除MyClass
,因为它将包含两次。 我认为这是目前最简单的解决办法。在相关问题 更多 >
编程相关推荐