如何告诉自动扩展扩展不仅列出单个班级,还列出所有班级成员?
如果我使用:
.. autosummary::
MyClass
在生成的html文件中,只会有一个简短的摘要,如:
MyClass(var1,var2,....)我的自定义类来做奇特的事情......
我真正想要的是:
MyClass(var1,var2,....)我的自定义类来做奇特的事情......
MyClass.doA(var1,var2,...)做得很好
MyClass.doB(var1,var2,...)B更好吗
我如何配置autosummary指令才能得到这个(除了在autosummary指令中自己命名所有函数)? 谢谢!
答案 0 :(得分:16)
您可以像下面这样扩展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)
答案 1 :(得分:2)
您还必须输入班级成员
.. autosummary::
MyClass
MyClass.doA
MyClass.doB
我喜欢用标题或者像
这样的标题来分割它.. rubric:: Classes
.. autosummary::
MyClass
.. rubric:: MyClass Members
.. autosummary::
MyClass.doA
MyClass.doB
答案 2 :(得分:0)
也许你应该使用sphinx提供的autoclass,你可以通过替换autosummary来解决这个问题:
.. autoclass:: MyClass
:members: