Open
Description
Summary
Roles, like
:sql:`SELECT * FROM table`
are not defined, so typos or unsupported roles cannot be warned about, like (mind the g
instead the q
):
:sgl:`SELECT * FROM table`
In Sphinx, custom roles have to be defined:
https://www.sphinx-doc.org/en/master/usage/restructuredtext/roles.html#inline-code-highlighting
On rendering, Sphinx displays an error about an unknown role:
ERROR: Unknown interpreted text role "sgl".
This way, the user can spot the error and correct it.
Guides holds no definition of custom roles and therefore cannot warn about it.