python - 以编程方式使用特定于 Sphinx 的指令解析 .rst 文件

Question

我希望能够在 Python 中解析基于 sphinx 的 rst 以进行进一步处理和检查。就像是：

import sphinx
p = sphinx.parse("/path/to/file.rst")
do_something_with(p)

使用 docutils.core.publish_file 在 docutils 中似乎有一些可能：

publish_file(open("/path/to/file.rst")

但这对狮身人面像特定指令等一无所知......

Answer 1

您可以在最终写入之前使用Sphinx Extensions进行自定义处理。文档中有一个很好的入门示例项目，它讨论了允许您自定义 Sphinx 的各种钩子。

根据您要执行的操作，您可能需要将您的do_something函数作为回调参数提供给这些事件之一。

doctree-resolved(app, doctree, docname)
html-page-context(app, pagename, templatename, context, doctree)

然后你可以扩展狮身人面像如下

def setup(app):
    app.connect('doctree-resolved', do_something)

如果 Sphinx 教程中的示例不够详细，Doug Hellmann 还有一篇关于为 Sphinx 创建拼写检查器的博文。我发现它是我不得不写的 Sphinx 扩展的有用参考。