Autodoc __init __(自我)方法:获取" autodoc-skip-member"上班

时间:2015-09-02 17:36:49

标签: python-sphinx

之前的问题是让Sphinx仅记录某些特殊方法(在这种情况下为$form):How to use Sphinx's autodoc to document a class's __init__(self) method?

接受的答案列出了3个选项,第一个选项是使用自定义函数来处理" autodoc-skip-member"事件。答案建议将此代码添加到__init__(self)

conf.py

这在我的情况下确实很有用,因为它是全局的,即不需要编辑* .rst文件。问题是,我无法让它发挥作用。我已将代码添加到def skip(app, what, name, obj, skip, options): if name == "__init__": return False return skip def setup(app): app.connect("autodoc-skip-member", skip) ,但conf.py方法未显示在文档中。我可以用

__init__()

包含所有特殊方法,但我真的希望有更多控制权,只包括其中一些(autodoc_default_flags = ['special-members'] __init__())。这种方法对其他人有用吗?为了让它发挥作用,还有什么我需要做的吗?

谢谢, 阿列克谢

1 个答案:

答案 0 :(得分:0)

Per http://doc.qt.io/qt-5/qtmultimedia-multimediawidgets-videographicsitem-example.html,与拿破仑发生冲突的地方,如果您正在使用任何也为" autodoc-skip-member"设置处理程序的扩展程序。事件只会使用其中一个处理程序。这可能是你遇到的问题吗?