将Sphinx autodocskipmember连接到我的函数

2024-06-01 00:09:06 发布

您现在位置:Python中文网/ 问答频道 /正文

我想使用sphinx's autodoc-skip-member事件来选择某个python类上的一部分成员作为文档。

但是从sphinx文档中还不清楚,我也找不到任何例子来说明:我应该把代码放在哪里来连接它?我看到了Sphinx.connect,我怀疑它进入了我的conf.py中,但是当我在conf.py中尝试此代码的变体时,我找不到应该连接的app对象():

def maybe_skip_member(app, what, name, obj, skip,
                                  options):
    print app, what, name, obj, skip, options
    return False

# This is not even close to correct:
#from sphinx.application import Sphinx
#Sphinx().connect('autodoc-skip-member', maybe_skip_member)

一个简单例子的指针是理想的。


Tags: 代码name文档pyappconfconnectsphinx