पायथन स्फिंक्स ऑटोसमैरी: सदस्य फ़ंक्शंस की स्वचालित सूची

Question

मैं ऑटोसमरी एक्सटेंशन कैसे बता सकता हूं कि न केवल एक वर्ग की सूची बल्कि सभी वर्ग के सदस्यों को भी सूचीबद्ध किया जाए?

अगर मैं का उपयोग करें:

.. autosummary:: 

    MyClass 

जिसके परिणामस्वरूप html फ़ाइल में, वहाँ केवल हो जाएगा एक संक्षिप्त सारांश की तरह:

MyClass (var1, var2, ....) मेरा कस्टम करने के लिए वर्ग फैंसी बातें ...

क्या मैं वास्तव में चाहता हूँ की तरह कुछ:

MyClass (var1, var2, ....) मेरा कस्टम फैंसी काम करने के लिए वर्ग ...

MyClass.doA (var1, var2, ...) करता है एक बहुत अच्छी तरह

MyClass.doB (var1, var2, ...) क्या बी और भी बेहतर

मैं कैसे कॉन्फ़िगर करने के लिए है यह प्राप्त करने के लिए स्वत: अनुमोदन निर्देश (ऑटोमोमरी निर्देश में सभी कार्यों को कड़ाई से नाम देने के अलावा)? धन्यवाद!

Answer 1

आप ऑटोसमुमा का विस्तार कर सकते हैं नीचे और इसे इस तरह फोन की तरह ry निर्देश:

.. autoclass:: your.fully.qualified.path.to.the.Class 
    :members: 
    :undoc-members: 

    .. rubric:: Methods 

    .. autoautosummary:: your.fully.qualified.path.to.the.Class 
     :methods: 

    .. rubric:: Attributes 

    .. autoautosummary:: your.fully.qualified.path.to.the.Class 
     :attributes: 

कोड:

from sphinx.ext.autosummary import Autosummary 
from sphinx.ext.autosummary import get_documenter 
from docutils.parsers.rst import directives 
from sphinx.util.inspect import safe_getattr 
import re 

class AutoAutoSummary(Autosummary): 

    option_spec = { 
     'methods': directives.unchanged, 
     'attributes': directives.unchanged 
    } 

    required_arguments = 1 

    @staticmethod 
    def get_members(obj, typ, include_public=None): 
     if not include_public: 
      include_public = [] 
     items = [] 
     for name in dir(obj): 
      try: 
       documenter = get_documenter(safe_getattr(obj, name), obj) 
      except AttributeError: 
       continue 
      if documenter.objtype == typ: 
       items.append(name) 
     public = [x for x in items if x in include_public or not x.startswith('_')] 
     return public, items 

    def run(self): 
     clazz = str(self.arguments[0]) 
     try: 
      (module_name, class_name) = clazz.rsplit('.', 1) 
      m = __import__(module_name, globals(), locals(), [class_name]) 
      c = getattr(m, class_name) 
      if 'methods' in self.options: 
       _, methods = self.get_members(c, 'method', ['__init__']) 

       self.content = ["~%s.%s" % (clazz, method) for method in methods if not method.startswith('_')] 
      if 'attributes' in self.options: 
       _, attribs = self.get_members(c, 'attribute') 
       self.content = ["~%s.%s" % (clazz, attrib) for attrib in attribs if not attrib.startswith('_')] 
     finally: 
      return super(AutoAutoSummary, self).run() 

app.add_directive('autoautosummary', AutoAutoSummary) 

Answer 2

शायद तुम autoclass स्फिंक्स द्वारा प्रदान का उपयोग करना चाहिए, आप उस संपर्क कर सकते हैं autosummary की जगह:

.. autoclass:: MyClass 
    :members: 

Answer 3

साथ ही आप वर्ग के सदस्यों को बाहर टाइप करने के लिए

.. autosummary:: 

    MyClass 
    MyClass.doA 
    MyClass.doB 

है मैं इसे विभाजित करना चाहते शीर्षक या रूब्रिक जैसे

.. rubric:: Classes 

.. autosummary:: 

    MyClass 


.. rubric:: MyClass Members 

.. autosummary:: 

    MyClass.doA 
    MyClass.doB