首页
学习
活动
专区
工具
TVP
发布
精选内容/技术社群/优惠产品,尽在小程序
立即前往

如何从Sphinx autodoc中排除pytest test_*函数?

Sphinx autodoc是Sphinx文档生成工具的一个插件,用于自动提取并生成文档。pytest是一个Python的测试框架,它会自动发现并执行以"test_"开头的测试函数。

要从Sphinx autodoc中排除pytest test_*函数,可以通过配置Sphinx的autodoc插件来实现。具体步骤如下:

  1. 打开Sphinx项目的配置文件,一般为conf.py
  2. 在配置文件中找到extensions部分,确保sphinx.ext.autodoc插件已经被启用,如果没有启用,可以添加以下代码:
代码语言:txt
复制
extensions = [
    'sphinx.ext.autodoc',
]
  1. 在配置文件中添加以下代码,用于排除pytest test_*函数:
代码语言:txt
复制
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)
  1. 保存配置文件并重新生成文档。

以上配置会在自动生成文档时,跳过以"test_"开头的函数,从而排除pytest test_*函数。

关于Sphinx autodoc的更多信息,可以参考腾讯云的产品文档:Sphinx autodoc介绍

注意:本回答中没有提及具体的云计算品牌商,如需了解相关产品和服务,建议参考腾讯云官方文档或咨询腾讯云客服。

页面内容是否对你有帮助?
有帮助
没帮助

相关·内容

领券