小编mar*_*her的帖子

sphinx“ autodoc-skip-member”,不推荐使用装饰器

试图从我的狮身人面像文档中排除已弃用的修饰成员/功能:

到目前为止,我在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)
Run Code Online (Sandbox Code Playgroud)

装饰器在func_dict中将“ 已弃用 ”值设置为True。

在狮身人面像构建过程中,它将输出所有所需的函数名称(打印“跳过” +名称)。但是它们仍然显示在最终文档中,但没有文档字符串。我的意图是,真的将那些成员排除在外。

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

如果您需要其他信息,请提出要求:)

python python-sphinx

5
推荐指数
0
解决办法
266
查看次数

标签 统计

python ×1

python-sphinx ×1