Skip to content

[Bug]: Roles cannot be checked as they are not defined #925

Open
@brotkrueml

Description

@brotkrueml

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.

Metadata

Metadata

Assignees

Labels

bugSomething isn't workingtriage

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions