编程语言
首页 > 编程语言> > 如何以纯数据格式获取Python Sphinx文档?

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

作者:互联网

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

:param message:要显示的消息
:type message:string
:返回:格式化字符串
:rtype:string

要求将Sphinx HTML文档替换为以不同方式组织/呈现的内容 – 但我们仍然希望从源文档中自动生成文档字符串.有没有办法用Sphinx以中介(如xml)格式生成文档?我发现没办法做到这一点.谁知道我会做什么?

解决方法:

您可以使用’json’构建器而不是HTML构建器,这将生成可解析的JSON输出.或者,您可以编写自己的构建器来创建所需的格式(有关当前构建器列表,请参阅http://sphinx.pocoo.org/builders.html).

标签:python,python-sphinx,restructuredtext
来源: https://codeday.me/bug/20190529/1181045.html