检查从 sphinx 扩展生成的 ReST

【问题标题】：Examine generated ReST from sphinx extension检查从 sphinx 扩展生成的 ReST
【发布时间】：2019-07-21 22:03:18
【问题描述】：

我正在使用 Sphinx 扩展 (this one)，它会动态生成一些 ReST 标记。 Sphinx 使用该 ReST 生成 html 文档。

我想检查并在生成的 ReST 标记上运行文档测试。通常我使用

sphinx-build -E -b html docs dist/docs

生成 html 输出，但没有与 html 等效的 rst "builder"。

如何检查生成的 ReST 标记？

【问题讨论】：

【解决方案1】：

使用 Sphinx 扩展 sphinx.ext.doctest，遵循其语法和标记。

然后运行make doctest 运行文档测试。

更新

响应您的 cmets 并接受 @mzjn 的建议，听起来您想在 reStructuredText 中生成一组中间文档。 Sphinx 扩展restbuilder 可能需要您寻找。

从那时起，make doctest 可能是你想要的。

【讨论】：

我使用 docshtest 不仅是原版的 sphinx.ext.doctest，因为我想测试 shell 演示。我找到了一种解决方法，但为了将来参考，是否可以检查从扩展生成的 rst？
“检查”是什么意思？当我检查一个文件时，我在编辑器中打开它并查看它，我认为你可以做到这一点。也许你的意思是别的？
我的意思是在文件中打开它。我的问题中的链接显示扩展生成了一些 rst，但我认为它从未写入文件，所以我不知道如何在我的编辑器中查看它（或在其上运行 docshtest）。