Jak przesłonić parametry konstruktorów w Sphinx przy pomocy autodoc?

Question

Powiedzmy mam klasy jak poniżej:

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

    Extended documentation for my class. 
    """ 

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

Jeśli używam Sfinks z rozszerzeniem autodoc udokumentowanie tej klasy tak:

.. automodule:: mymodule 
    :members: 

... podpis konstruktora pojawia się jako MyClass(*args). Wolałbym to zastąpić i udokumentować jako, powiedzmy, .

Gdyby to była funkcja, mógłbym zastąpić podpis w pierwszym wierszu docstrukcji. Ale ta sztuczka nie działa na klamrę klasową. W jaki więc sposób mogę przesłonić sygnaturę konstruktora?

Answer 1

Myślę, że najlepszym rozwiązaniem dla ciebie jest zrobić coś takiego:

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

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

MyClass będzie miał params nadpisane i innych członków mymodule będzie autodocumented. Musisz wykluczyć MyClass używając :exclude-members:, ponieważ będzie on dołączony dwa razy. Myślę, że to najprostsze rozwiązanie w tej chwili.