fix: Fix links to editors in guide/contributing.rst.
#2217
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Links to `Sublime Text` and `Visual Studio Code` editors were not being displayed as intended because the link syntax was not being parsed by `sphinx` inside the boldfaced text block. Fix was to isolate links outside of boldfaced block. This was tested in an alternate `sphinx` build environment to confirm links now show up on page as intended. An issue was not created about this.
plaindocs
approved these changes
Sep 12, 2024
|
@plaindocs Hi! Quick question if you don't mind me asking: What processes expressions like |
|
Yeah, those are part of the Sphinx theme, which is Alabaster. See https://github.com/writethedocs/www/blob/main/docs/conf.py#L118 and https://alabaster.readthedocs.io/en/latest/customization.html |
Sweet! Thanks for letting me pick your brain. :-) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Links to
Sublime TextandVisual Studio Codeeditors were not being displayed as intended because the link syntax was not being parsed bysphinxinside the boldfaced text block. Fix was to isolate links outside of boldfaced block. This was tested in an alternatesphinxbuild environment to confirm links now show up on page as intended.An issue was not created about this.
📚 Documentation preview 📚: https://writethedocs-www--2217.org.readthedocs.build/