Sphinx文档，包括单元测试输出

Question

这是一个如何/最佳实践问题。

• 我有一个代码库，并带有以pytest运行的一组单元测试
• 我有一组*.rst文件，它们提供每个测试的解释以及结果表和一些数学绘图的图像
• 每次pytest套件运行时，它都会使用最新测试数据的结果动态更新*.rst文件，更新数值，为测试加上时间戳，等等

我想将其与项目文档集成。我可以

• [每当我想查看测试结果时，都用sphinx-build分别构建这些第一个文件[这似乎很糟糕，因为它很费力并且不是自动化的]
• 告诉Sphinx分别渲染这些页面并将它们包含在项目文档中[更好，但是我不确定如何配置此页面]
• 具有一组单独的Sphinx文档以获取测试结果，我可以在每次运行测试套件后构建这些结果

哪种方法（或另一种方法）最有效？有没有做这种事情的最佳实践？

Answer 1

也许看看Sphinx-Test-Reports，它从基于junit的xml文件中读取所有信息（pytest支持此操作，并在正常的狮身人面像构建阶段生成输出。

因此，您可以随意在测试结果周围添加自定义信息。

Example from webpage:

.. test-report:: My Report
   :id: REPORT
   :file: ../tests/data/pytest_sphinx_data_short.xml

对您的问题的完整答案：不采取任何给定的方法，并在构建期间让狮身人面像扩展进行操作。