Como faço para substituir os parâmetros do construtor no Sphinx com autodoc?
Digamos que eu tenha uma aula assim:
class MyClass(object):
""" Summary docs for my class.
Extended documentation for my class.
"""
def __init__(self, *args):
self.values = np.asarray(args)
Se eu usar o Sphinx com oautodoc
extensão para documentar esta classe da seguinte forma:
.. automodule:: mymodule
:members:
... a assinatura do construtor aparece comoMyClass(*args)
. Eu preferiria substituir isso e documentá-lo como, digamos,MyClass(first, second, third)
.
Se isso fosse uma função, eu poderia substituir a assinatura na primeira linha da docstring. Mas esse truque não parece funcionar em um docstring de classe. Então, como posso substituir a assinatura do construtor?