CODEWITHSUNDEEP
python-sphinxrestructuredtext
NuclearPeon
NuclearPeon

Reputation: 6059

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

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.

Upvotes: 2

Views: 1176

Answers (2)

SilverRainZ
SilverRainZ

Reputation: 326

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

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

Upvotes: 3

NuclearPeon
NuclearPeon

Reputation: 6059

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.

Upvotes: 2

Related Questions