Sphinx RST表格中$符号引发未定义替换错误的技术问询

在reStructuredText语法里，|xxx|格式会被Sphinx识别为替换引用，所以你表格里的|$|会被当成一个未定义的替换项，进而抛出Undefined substitution referenced: "$"错误——哪怕最终文档能正常显示$符号，这个错误提示也会存在。

给你几种直接有效的解决办法：

• 转义竖线：把单元格里的|$|改成\|$\|，让竖线不被识别为替换引用标记，修改后的表格代码：

+--------+---------+
| Test   | Field   |
+--------+---------+
| \|$\|  | Errors  |
+--------+---------+

• 用反引号包裹为行内代码：如果需要保留竖线和$的显示，把整个内容用反引号包裹，这样Sphinx会把它当作代码内容，跳过替换引用解析：

+--------+---------+
| Test   | Field   |
+--------+---------+
| `|$|`  | Errors  |
+--------+---------+

如果不需要竖线，直接写$即可，完全不会触发错误。

• 定义替换项（不推荐）：在文档开头添加.. |$| replace:: $，提前定义这个替换引用，但这种方法没必要，除非你有大量重复的|$|需要统一处理。

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