Sphinx代码块中的替换

Question

在这个reST示例意味着由Sphinx呈现,| yaco_url | 不会被替换,因为它在代码块中:

.. |yaco_url| replace:: http://yaco.es/

You can use wget to download it:

.. code-block:: console

    $ wget |yaco_url|package.tar.gz

我想知道是否有某种方法可以强制更换| yaco_url | 在渲染代码块之前.

Answer 1

使用"parsed-literal"指令.

.. parsed-literal::

    ./home/user/somecommand-|version|

资料来源:https://groups.google.com/forum/？fromgroups =#!topic/facx- dev/ABzaUiCfO_8:

Answer 2

找到了一个更好的解决方案（在我看来），可以在其他指令中使用，例如:samp:并且可能对未来的读者有用。

配置.py：

def ultimateReplace(app, docname, source):
    result = source[0]
    for key in app.config.ultimate_replacements:
        result = result.replace(key, app.config.ultimate_replacements[key])
    source[0] = result

ultimate_replacements = {
    "{TEST}" : "replaced"
}

def setup(app):
   app.add_config_value('ultimate_replacements', {}, True)
   app.connect('source-read', ultimateReplace)

还有这种标记：

.. http:get:: testing/replacement/{TEST}

正确生成如下：

testing/replacement/replaced

请注意，如果使用它来替换指令中的参数，则需要:samp:双括号。{

:samp:`func({{TEST}})`.

来源： https: //github.com/sphinx-doc/sphinx/issues/4054