如何以纯数据格式获取 Python Sphinx 文档？

Question

我正在开发一个非常大的代码库，它使用 sphinx-apidoc 从 Python 源代码中的文档字符串自动生成 HTML 文档。文档字符串使用以下格式：

:param message: 要显示的消息
：类型消息：字符串
:returns: 格式化字符串
:rtype: 字符串

将 Sphinx HTML 文档替换为组织/呈现方式不同的内容已成为一项要求——但我们仍然希望从源代码中的文档字符串自动生成。有没有办法用 Sphinx 生成中间（如 xml）格式的文档？我发现没有办法做到这一点。有人知道我会怎么做吗？

Answer 1

您可以使用“json”构建器而不是 HTML 构建器，它会生成可解析的 JSON 输出。或者，您可以编写自己的构建器来创建您想要的格式（有关当前构建器列表，请参阅 https://www.sphinx-doc.org/en/master/usage/builders/index.html）。