Dołącz konkretne specjalne metody w sfinks

Mam kilka klas, które używają „specjalne metody”:Dołącz konkretne specjalne metody w sfinks

class Foo(object): 
    "Foo docstring" 

    attr1 = "Attribute!" #: first attribute 
    attr2 = "Another Attribute!" #: second attribute 

    def __init__(self): 
     self.x = 12 

    def say_hello(self): 
     """ 
     say_hello(self) -> None 

     Issue a friendly greeting. 
     """ 
     print "Hello! x is {0}".format(self.x) 

    def __contains__(self,other): 
     """Implement ``other in self``""" 
     return other == self.x

teraz chciałbym do generowania dokumentacji HTML dla tego używając Sfinksa i AutoDoc. Jak mogę powiedzieć Sphinxowi, aby udokumentował __contains__? Próbowałem dodanie

autodoc_default_flags = ['members', 'undoc-members', 'special-members']

do conf.py, ale również __dict__ który zdecydowanie nie chce.

Obecnie odpowiednie porcje wygląd myproject.rst plików takich jak:

.. automodule:: myproject.foomodule 
    :members: 
    :undoc-members: 
    :show-inheritance:

edycji dodając

.. automodule:: myproject.foomodule 
    :members: 
    :undoc-members: 
    :show-inheritance: 

.. automethod:: myproject.foomodule.Foo.__contains__

robi dodać dokumentację tej metody, ale w osobnym rozdziale - nie tak część dokumentacji klasy Foo.

Źródło

2013-04-09 mgilson

OTTOMH - Wierzę, że muszą być wyraźne i używać '.. automethod :: __contains__' jak nie wierzę' specjalnego members' akceptuje żadnej formy filtrowania parametr –

Przykład w pytaniu nie przedstawia dokładnie argumentu za udokumentowaniem tej metody. Nie ma sensu dokumentowanie '__contains__', jeśli po prostu powie ci, czy obiekt jest członkiem kolekcji. To [już udokumentowane w Pythonie] (http://docs.python.org/3/reference/datamodel.html#object.__contains__). Możesz podać w docstringu dla klasy, że obsługiwany jest operator 'in'. –

@JonClements - Wydaje się być blisko. Dodałem '.. automethod :: myproject.foomodule.Foo .__ includes__'' po powyższym przykładzie' ..automethod' i dodano dokumentację, ale jest ona dokumentowana oddzielnie od klasy. – mgilson

Obecnie nie jestem w 100% zachwycony tym rozwiązaniem, więc mam nadzieję, że ktoś może go ulepszyć. Jednak sposób mam rozwiązać tego problemu jest wykonanie następujących czynności:

.. automodule:: myproject.foomodule 
    :members: 
    :undoc-members: 
    :show-inheritance: 

    .. autoclass:: myproject.foomodule.Foo 
     :exclude-members: attr1,attr2 

     .. autoattribute:: myproject.foomodule.Foo.attr1 

     .. autoattribute:: myproject.foomodule.Foo.attr2 

     .. automethod:: myproject.foomodule.Foo.__contains__

Tu rzeczywiście trzeba powiedzieć autodoc uniknąć dokumentowania atrybuty klasy (automatycznie) i następnie trzeba dodać je z powrotem na wprost. Powodem jest to, że najwyraźniej, gdy jawnie zagnieżdżasz komendy, explicit ones come first. Jeśli tylko jednoznacznie dodaję __contains__, to pojawi się przed atrybutami, które mi się nie podobają.

Źródło

2013-04-09 14:48:50 mgilson

Czy http://stackoverflow.com/a/21449475/832230 pomaga? –

Można dodać:

:special-members: 
:exclude-members: __dict__,__weakref__

do pliku .rst aby pokazać specjalne członków, z wyjątkiem __dict__ i __weakref__

Źródło

2013-05-06 13:12:57 arutaku

Co pracował dla mnie jest dodanie”.. automethod :: methodName "

Dyrektywy w docstringu klasy, zamiast robić to w pliku .rst.

Tak, można zmienić "Foo docstring" do

""" 
Foo docstring 

.. automethod:: __contains__ 
"""

Źródło

2014-02-28 05:55:23 rb3363392

Dobrze wiedzieć. Jestem (niestety) nie jestem już w stanie używać sfinksa - więc nie mogę tego przetestować. Na pewno dam sobie spokój, jeśli kiedykolwiek będę miał szansę. – mgilson

Opcja special-members teraz trwa argumentów (jest to nowa funkcja w Sphinx 1.2).

Tak to powinno działać:

.. automodule:: myproject.foomodule 
    :members: 
    :undoc-members: 
    :special-members: __contains__ 
    :show-inheritance:

Źródło

2014-02-28 08:10:59 mzjn

Dołącz konkretne specjalne metody w sfinks

Odpowiedz

Powiązane problemy