Как переопределить параметры конструктора в Sphinx с помощью autodoc?
Позволять'скажем, у меня есть такой класс:
class MyClass(object):
""" Summary docs for my class.
Extended documentation for my class.
"""
def __init__(self, *args):
self.values = np.asarray(args)
Если я использую Сфинкс сautodoc
расширение для документирования этого класса примерно так:
.. automodule:: mymodule
:members:
... подпись конструктора выглядит какMyClass(*args)
, Я предпочел бы переопределить это и задокументировать это, скажем, как.MyClass(first, second, third)
Если бы это была функция, я мог бы переопределить подпись в первой строке строки документа. Но этот трюк неКажется, он работает с классной строкой документации. Итак, как я могу переопределить сигнатуру конструктора?