python - 变量替换在 Sphinx 中无法正常工作

Question

我有一个使用 Sphinx 制作的文档项目。我通过配置键 rst_epilog 来使用全局变量。我的 conf.py 文件包含以下内容:

rst_epilog = """
.. |MY_VERSION| replace:: 2.1.0
"""

然后，在第一个页面中，我使用以前定义的变量 (VERSION)，如下所示:

The version of my repo is: |MY_VERSION|

.. sourcecode:: bash

    git clone https://github.com/my-organization/my-repo.git
    cd my-repo
    git checkout |MY_VERSION|

构建文档后，在生成的 HTML 中，第一个变量被正确替换，但第二个变量则不然:

显然，替换在格式化的源代码块内不起作用，这非常不方便。

是否可以解决此问题？

PS:我也尝试使用 rst_prolog 得到相同的结果。

Answer 1

这将使替换工作:

.. parsed-literal::

   git clone https://github.com/my-organization/my-repo.git
   cd my-repo
   git checkout |MY_VERSION|

与 parsed-literal指令，您可以进行替换(和其他内联标记)，但没有语法突出显示。

与 code-block (或sourcecode，或highlight)，您可以进行语法突出显示，但不会处理内联标记。