python的summary函数_Python Sphinx Autosummary：成员函数的自动列表

您可以像下面这样扩展Autosummary指令并这样调用它：.. 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:

代码(在conf.py中)：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()

def setup(app):

app.add_directive('autoautosummary', AutoAutoSummary)