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

问题描述

我希望能够在Python中解析基于狮身人面像的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")

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

---

解决方案

您可以在最终写入前使用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创建拼写检查器的blog post。我发现它是我不久前不得不编写的Sphinx扩展的有用参考。