Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Recognise (and potentially highlight) roles of interpreted text #66

Open
ghost opened this issue Sep 21, 2021 · 0 comments
Open

Recognise (and potentially highlight) roles of interpreted text #66

ghost opened this issue Sep 21, 2021 · 0 comments

Comments

@ghost
Copy link

ghost commented Sep 21, 2021

It would be nice if roles like ":role:text" and text:role:" [1] would be recognised by this syntax plugin.
This would allow syntax highlighting and spell checking (see #12).

Notes:

  • Valid role names "conform to the rules of simple reference names" [2].
  • Roles can be pre- (":role:text") or post (text:role:")
  • Be aware that Sphinx has "domains" whose roles contain a colon, e.g. ":py:role:text". This should also be supported (should be covered by [2] but want to point it out due to the internal colon and its wide-spread usage).
  • Be aware that the :text: syntax is also used in field lists.

[1] https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#interpreted-text
[2] https://docutils.sourceforge.io/docs/ref/rst/directives.html#role-name

@ghost ghost mentioned this issue Sep 22, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

0 participants