Sphinx autodoc是Sphinx文档生成工具的一个插件,用于自动提取并生成文档。pytest是一个Python的测试框架,它会自动发现并执行以"test_"开头的测试函数。
要从Sphinx autodoc中排除pytest test_*函数,可以通过配置Sphinx的autodoc插件来实现。具体步骤如下:
conf.py
。extensions
部分,确保sphinx.ext.autodoc
插件已经被启用,如果没有启用,可以添加以下代码:extensions = [
'sphinx.ext.autodoc',
]
import inspect
def autodoc_skip_member(app, what, name, obj, skip, options):
if what == 'module' and inspect.isfunction(obj) and obj.__name__.startswith('test_'):
return True
return skip
def setup(app):
app.connect('autodoc-skip-member', autodoc_skip_member)
以上配置会在自动生成文档时,跳过以"test_"开头的函数,从而排除pytest test_*函数。
关于Sphinx autodoc的更多信息,可以参考腾讯云的产品文档:Sphinx autodoc介绍。
注意:本回答中没有提及具体的云计算品牌商,如需了解相关产品和服务,建议参考腾讯云官方文档或咨询腾讯云客服。
领取专属 10元无门槛券
手把手带您无忧上云