我想使用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)
指向一个简单示例的指针是理想的.
我有一个模块,有两个记录的全球特殊成员.
在本地运行Sphinx会创建包含其文档的文档,但"阅读文档"却没有.它使用内置类型的文档.
我尝试了两种样式:#:和定义后的docstring.我已多次阅读autodoc的文档,并阅读了文档条目.我无法弄清楚我缺少什么,因为我甚至没有看到阅读文档中的任何构建错误.
有任何想法吗？