Sphinx RST ERROR: Undefined substitution referenced: "$". in table

user_1703772 0
Viewed 35

I am writing a sphinx rst table and one of the cells contains a certain symbol that errors.

Here is an example:

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

This results in ERROR: Undefined substitution referenced: "$"., even though this is the symbol I want in my table. It still shows up in the resulting documentation though.

restructuredtext python-sphinx
2 Answers

|x| is recognized as a substitution reference, using \ to escape it should work for you.

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

The solution I found was to simply surround |&| with two backticks:

``|$|``

It does make the text monospace, but it doesn't bother me. I no longer have the error in my console.

user_17037720
Related