cloud_sptheme.ext.escaped_samp_literals
- permits escaped bracket characters in samp role¶
Overview¶
This extension modifies how :samp:
literals are parsed, replacing
the default Sphinx parser with an alternate one that allows embedding
literal {
and }
characters within the content, as well providing
stricter input validation.
To embed a literal {
, just use a double-backslash, e.g:
:samp:`this is a {variable}, these are a literal \\{ and \\}`
... and it will be rendered as:
this is a variable, these are a literal { and }
Internals¶
Note
This feature has been submitted to the Sphinx issue tracker. If and when the patch is accepted (or an alternative is added to Sphinx), this extension will be deprecated and eventually removed.