:literalref: should be able to work like :ref:

[lengau]

Currently using literalref is a bit unintuitive, as it can only work like standard reStructuredText links. It should also be able to reference labels like :ref:.

[SecondSkoll]

literalref is only intended for use with HTML links, as it prevents the spellcheck from parsing the link text. What's the use case for internal references?

literalref - Renders the provided reference in code-style, which excludes the link text from the spelling checker. You can provide either just the link (for example, :literalref:www.example.com , which results in www.example.com as the link text and https://www.example.com as the link URL) or a separate link text and URL (for example, :literalref:xyzcommand <www.example.com> ).

[lengau]

We have a lot of cases where we want to link to a reference that refers to a YAML key, a filename, a charmcraft command, etc., that should be treated as literals as well. A nice example of the first three listed is at https://canonical-charmcraft.readthedocs-hosted.com/en/stable/reference/files/charmcraft-yaml-file/:

1. charmcraft init should be both a literal and a link to the command.
2. The link to actions.yaml should be the same.
3. Some sections have cross-references to other sections within the file that are YAML key sections.

[SecondSkoll]

I see, that's fair. I'm not sure when we'll be able to give this the attention it deserves, but for the moment, the combo-roles extension can be used to combine the code and ref roles. I've verified it works.

[medubelko]

The combo-roles site is down for me. The repo is here: https://github.com/sphinx-notes/comboroles