Sphinx如何在rst文件中显示conf.py定义的自定义字符串变量

要让自定义变量像内置的release一样，在rst中通过|X|调用显示对应值，需在conf.py里同时完成两项操作：定义变量，以及将变量注册为rst可识别的替换标记。具体步骤如下：

1. 修改conf.py文件：

# 定义自定义变量
X = "MY CUSTOM STRING"

# 将变量注册为rst替换标记
rst_prolog = f"""
.. |X| replace:: {X}
"""

rst_prolog是Sphinx的全局配置项，会自动在每个rst文档的开头插入指定内容，相当于给所有文档统一配置了|X|的替换规则。

2. 在rst文件中正常使用|X|：

Using |X|

生成HTML后，|X|就会被替换为MY CUSTOM STRING。

如果需要添加多个自定义变量，直接扩展rst_prolog即可：

X = "MY CUSTOM STRING"
Y = "ANOTHER VALUE"

rst_prolog = f"""
.. |X| replace:: {X}
.. |Y| replace:: {Y}
"""

内容的提问来源于stack exchange，提问作者dada