首页
学习
活动
专区
圈层
工具
发布
社区首页 >问答首页 >Autodoc a __init__(self)方法:让"autodoc-skip-member“正常工作

Autodoc a __init__(self)方法:让"autodoc-skip-member“正常工作
EN

Stack Overflow用户
提问于 2015-09-03 01:36:49
回答 1查看 1.5K关注 0票数 0

前面还有一个问题是让Sphinx只记录特定的特殊方法(在这种情况下是__init__(self) ):How to use Sphinx's autodoc to document a class's __init__(self) method?

被接受的答案列出了3个选项,第一个是使用自定义函数来处理"autodoc-skip-member“事件。答案是建议将以下代码添加到conf.py

代码语言:javascript
复制
def skip(app, what, name, obj, skip, options):
    if name == "__init__":
        return False
    return skip

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

在我的例子中,这将非常有效,因为它是全局的,即不需要编辑*.rst文件。问题是,我不能让它工作。我将代码添加到conf.py中,但是,__init__()方法没有出现在文档中。我可以用

代码语言:javascript
复制
autodoc_default_flags = ['special-members']

包括所有特殊的方法,但我真的希望有更多的控制,只包括其中的一部分(__init__()和可能的__repr__())。这种方法对其他人有效吗?要让它正常工作,我还需要做什么吗?

谢谢,Aleksey

EN

回答 1

Stack Overflow用户

发布于 2016-03-30 00:42:36

根据与拿破仑冲突的https://github.com/sphinx-doc/sphinx/issues/2374,如果您使用的任何扩展也为"autodoc-skip-member“事件设置了一个处理程序,则只会使用其中一个处理程序。这可能是您遇到的问题吗?

票数 0
EN
页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持
原文链接:

https://stackoverflow.com/questions/32359700

复制
相关文章

相似问题

领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档