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

Inline links cannot have non-special character in place of third end-character #126

Open
JulianGro opened this issue Mar 28, 2021 · 0 comments

Comments

@JulianGro
Copy link
Contributor

Inline links cannot have non-special character in place of third end-character.
Apparently Sphinx will always interpret the third end-character, even if there is an "invalid" character there.
Meaning that a link like:

`English <https://docs.vircadia.dev/>`_man

won't work. In this case Sphinx will try to interpret m as part of the "end-string", fail to interpret it and thous fail to create the link when in the build.

To work around this problem, one either puts a special character in the place of the third end-character or a space behind the link, depending on if you are okay with having a space in the finished build there or not.
E.g.:

`English <https://docs.vircadia.dev/>`_\man

or

`English <https://docs.vircadia.dev/>`_ man

Interestingly a . seems to be a special case. I assume since people often want to put a . behind a link, they added this exception.

Keep in mind that _ has the function of anonymizing a link, so it should not be used to work around this limitation.

My understanding is that Sphinx should ideally just interpret every character it doesn't know like it does with ., but I will have to do some digging to see if this limitation can be fixed or not.

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

1 participant