शामिल स्फिंक्स

Question

में विशिष्ट विशेष तरीकों मैं जो उपयोग "विशेष-तरीकों" वर्गों का एक समूह है:

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 

अब मैं इस स्फिंक्स और autodoc प्रयोग करने के लिए एचटीएमएल प्रलेखन उत्पन्न करने के लिए करना चाहते हैं। मैं स्पिंक्स को __contains__ दस्तावेज करने के लिए कैसे कहूं? मैं conf.py को

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

जोड़ने की कोशिश की, लेकिन वह भी __dict__ जो मैं निश्चित रूप से नहीं चाहिए शामिल थे।

वर्तमान में, जैसे myproject.rst फ़ाइल देखो के प्रासंगिक अंश:

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

संपादित जोड़ने

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

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

कि विधि के प्रलेखन जोड़ने करता है, लेकिन एक अलग खंड में - नहीं के रूप में Foo वर्ग दस्तावेज का हिस्सा।

Answer 1

मैं वर्तमान में इस समाधान के साथ 100% रोमांचित नहीं हूं, इसलिए मुझे उम्मीद है कि कोई इसे सुधारने के साथ आ सकता है। हालांकि, जिस तरह से मैं इस समस्या का समाधान कर लिया है निम्न करने के लिए है:

.. 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__ 

यहाँ मैं वास्तव में autodoc बताने के लिए (स्वतः) वर्ग गुण का दस्तावेजीकरण से बचने के लिए और फिर मैं उन्हें पीठ पर स्पष्ट रूप से जोड़ने की जरूरत की जरूरत है। इसका कारण यह है कि जाहिर है जब आप स्पष्ट रूप से घोंसला आदेश, explicit ones come first। अगर मैं केवल __contains__ जोड़ने के लिए स्पष्ट रूप से कहता हूं, तो यह उन विशेषताओं से पहले दिखाई देता है जिन्हें मैं पसंद नहीं करता था।

Answer 2

आप जोड़ सकते हैं:

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

.rst दायर करने के लिए विशेष के सदस्यों को दिखाने के लिए, __dict__ को छोड़कर और __weakref__

Answer 3

क्या मेरे लिए काम किया ".. automethod :: methodName जोड़ रहा है "

कक्षा की डॉकस्ट्रिंग में निर्देश .rst फ़ाइल में करने के बजाय।

तो, आप

""" 
Foo docstring 

.. automethod:: __contains__ 
""" 

Answer 4

को "फू docstring" को बदल सकते हैं special-members विकल्प अब तर्क लेता है (इस स्फिंक्स 1.2 में एक नई सुविधा है)।

तो यह काम करना चाहिए:

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