用于创建类方法列表的自定义sphinx扩展

时间:2017-07-24 11:32:37

标签: python python-sphinx documentation-generation autodoc numpydoc

我一直在尝试创建sphinx扩展来生成类方法列表,只要使用autodoc记录类并将其附加到类级docstring下面(类似于numpydoc扩展所做的那样)。

对于我目前的方法,我将其添加到我的conf.py文件

def setup(app):
    def create_method_toc(app, what, name, obj, options, lines):
        if (what =="class"):
            # some code that creates stuff_to_be_added by calling a custom
            # role/directive
            lines.extend(['', stuff_to_be_added])
app.connect('autodoc-process-docstring', create_method_toc)

obj 参数包含当前类的成员,但我只需要autodoc将包含在文档中的方法(而不是方法autodoc discards)。

是否有更简单的方法可以执行此操作,如果没有,是否有一个变量包含有关autodoc记录哪些成员的信息 对于运行期间 autodoc-process-docstring(app,what,name,obj,options,lines)-event 中的每个类?

感谢。

0 个答案:

没有答案