Python Sphinx Autosummary：メンバー関数の自動リスト

Question

どのようにして、1つのクラスだけでなく、すべてのクラスのメンバーをリストアップするようにautosummary拡張機能に指示できますか？

私が使用している場合：行うには

のMyClass（VAR1、VAR2、....）私のカスタムクラス：

結果のHTMLファイル内

.. autosummary:: 

    MyClass 

、だけのようなもの短い要約があるだろう派手なもの...

私が実際にしたいことのようなものです：派手なことを行うために

のMyClass（VAR1、VAR2、....）私のカスタムクラス...

MyClass.doA（VAR1、VAR2、...）非常によく

MyClass.doB（VAR1、VAR2は、...）私は設定する必要がありますどのようにBより良い

行いませんautosummaryディレクティブを使って、これを得ることができます（autosummaryディレクティブですべての関数を退屈に指定することは別です）。 ありがとう！

Answer 1

あなたはAutosumma以下とこのようにそれを呼び出すよう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を使用する必要があり、あなたは自動サマリー置き換えることによって、それに近づくことができます。

.. autoclass:: MyClass 
    :members: 

Answer 3

をあなたが同様に

.. autosummary:: 

    MyClass 
    MyClass.doA 
    MyClass.doB 

をクラスメンバーを入力する必要が、私はそれを分割したいですタイトルやルービックのようなもの

.. rubric:: Classes 

.. autosummary:: 

    MyClass 


.. rubric:: MyClass Members 

.. autosummary:: 

    MyClass.doA 
    MyClass.doB