如何测试Sphinx文档的有效性？

Question

我有一大堆使用标准Sphinx .rst文件编写的Python包文档。我也对我的软件包进行了测试，其中我想包括一个测试文件是否可以正确编译到预期的输出中。基本上，我想抓住一些情况，当我使用链接到无处，或者有一个结构不良的标题等。

现在我知道我总是可以编写一个调用make html并测试退出代码的测试，但这感觉很脏，所以我认为必须有更好的方法。有人知道这是什么吗？

Answer 1

您可以使用与为代码创建相同的方式为文档创建单元测试。要捕获警告，您可以在Sphinx配置中设置warningiserror=True：

from django.utils import unittest
from sphinx.application import Sphinx


class DocTest(unittest.TestCase):
    source_dir = u'docs/source'
    config_dir = u'docs/source'
    output_dir = u'docs/build'
    doctree_dir = u'docs/build/doctrees'
    all_files = 1

    def test_html_documentation(self):
        app = Sphinx(self.source_dir,
                     self.config_dir,
                     self.output_dir,
                     self.doctree_dir,
                     buildername='html',
                     warningiserror=True,
        )
        app.build(force_all=self.all_files)
        # TODO: additional checks here if needed

    def test_text_documentation(self):
        # The same, but with different buildername
        app = Sphinx(self.source_dir,
                     self.config_dir,
                     self.output_dir,
                     self.doctree_dir,
                     buildername='text',
                     warningiserror=True,
        )
        app.build(force_all=self.all_files)
        # TODO:  additional checks if needed

    def tearDown(self):
        # TODO: clean up the output directory
        pass