sphinx" autodoc-skip-member"与不赞成的装饰

时间:2015-04-20 12:34:38

标签: python python-sphinx

尝试从我的sphinx文档中排除已弃用的装饰成员/函数:

到目前为止,我在sphinx / conf.py中有以下内容:

  # try to exclude deprecated                                                     
def maybe_skip_member(app, what, name, obj, skip, options):                     
    if hasattr(obj, "func_dict") and "__deprecated__" in obj.func_dict:         
       print "skipping " + name                                                 
       return True                                                              
    return skip or False                                                        

def setup(app):                                                                 
    app.connect('autodoc-skip-member', maybe_skip_member)

装饰者设置" 已弃用" func_dict中的值为True。

在sphinx-build期间,它会输出所有需要的函数名称(print" skip" + name)。但它们仍会出现在最终文档中,但没有文档字符串。我的意图是,那些成员真的被跳过了。

如何实现所需的行为(真正踢出那些装饰的功能)?

如果您需要其他信息,请索取:)

0 个答案:

没有答案