尽管在conf.py中排除了,Sphinx仍然为测试文件夹生成文档

问题描述 投票:0回答:1

我正在使用 Sphinx 为我的 Python 项目生成文档,并且我想将测试文件夹排除在生成的文档中。我已将“**/tests/*”添加到我的 conf.py 文件中的 except_patterns 列表中,如下所示:

exclude_patterns = ["_build", "Thumbs.db", ".DS_Store", "**/tests/*"]

这就是我的项目结构:

├───docs
├───Project
│   ├───Module1
│   │   │   file1.py
│   │   ├───tests
│   ├───reports
│   ├───tests
│   │   ├───tests
└───reports

但是,尽管进行了此配置,Sphinx 仍在为测试文件夹生成文档。

我已经仔细检查了语法并确保测试文件夹位于项目目录结构内。我还尝试在删除现有的构建文件后重新生成文档,但问题仍然存在。

我是否遗漏了某些内容或应该采取任何其他步骤来确保 Sphinx 从文档生成中排除测试文件夹?

任何解决此问题的帮助或见解将不胜感激。预先感谢您!

python testing documentation python-sphinx documentation-generation
1个回答
0
投票

您应该删除测试文件夹中的任何 init.py,这样 sphinx 就不会计算它。

© www.soinside.com 2019 - 2024. All rights reserved.