相关疑难解决方法(0)

将Sphinx autodoc-skip-member连接到我的函数

我想使用sphinx的autodoc-skip-member事件来选择某个python类中的一部分成员来获取文档.

但是从sphinx文档中不清楚,我找不到任何说明的例子:我在哪里放置代码来连接它?我看到Sphinx.connect,我怀疑它在我的conf.py中,但是当我在conf.py中尝试使用这些代码的变体时,我找不到应该连接的应用程序对象():

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)
Run Code Online (Sandbox Code Playgroud)

指向一个简单示例的指针是理想的.

python python-sphinx

30
推荐指数
2
解决办法
4788
查看次数

标签 统计

python ×1

python-sphinx ×1