python - Sphinx 中的源代码级转换

Question

我正在尝试编写执行源代码级转换的 sphinx 扩展，但我不知道如何实际更改输出文件。

我的扩展看起来像这样:

def my_source_handler(app, docname, source):
    import re
    print 'test'
    source = [re.sub("foo", "bar", source[0])]
    return source

def setup(app):
    app.connect('source-read', my_source_handler)
    app.add_config_value('my_source_handler_include', True, False)

但是，当我将模块添加到扩展列表并构建 html 时，它会打印“测试”但实际上不会将输出 HTML 中的“foo”更改为“bar”文件。

Sphinx documentation有点含糊，关于源参数，说“您可以处理内容并替换此项以实现源级转换”。

问题是我不确定应该如何替换源参数。

Answer 1

实际上经过一点挖掘我发现，你应该替换 source 的第一个(也是唯一一个)元素的内容，而不是替换 source 本身，就像:

def my_source_handler(app, docname, source):
    import re
    print 'test'
    source[0] = re.sub("foo", "bar", source[0])