Added escape for Sphinx characters to default value #49
Conversation
This file contains 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
RobertoRoos
force-pushed
the
bugfix/rst-escape
branch
from
944d0b7
to
abe114c
Compare
ashb
reviewed
May 1, 2024
| (".//section/dl/dd/p", 'Default:'), | ||
| (".//section/dl/dd/p/code/span", '420'), | ||
| (".//section/dl/dd/p/code/span", "'*.rst"), | ||
| (".//section/dl/dd/p/code/span", r"\['\*.rst',"), |
There was a problem hiding this comment.
What does this look like in the rendered HTML (both HTML source, and in a browser) please?
There was a problem hiding this comment.
The result from the test method:
In HTML (formatting mine):
<p>
Default:
<code class="docutils literal notranslate">
<span class="pre">'*.rst</span>
<span class="pre">_txt_</span>
<span class="pre">**strong**</span>
<span class="pre">*italic*</span>
<span class="pre">\`\`code\`\`'</span>
</code>
</p>
abe114c
to
2ca79b6
Compare
RobertoRoos
force-pushed
the
bugfix/rst-escape
branch
from
2ca79b6
to
9a02c55
Compare
RobertoRoos
commented
May 1, 2024
| else: | ||
| arg.append(f"Default: {entry['default']}") | ||
| # Put the default value in a literal block - but escape backticks already in the string | ||
| default_str = str(entry['default']).replace('`', r'\`') |
There was a problem hiding this comment.
Small problem: the
\`
is displayed in the webbrowser literally. I haven't been able to property escape it in Sphinx to display it properly in a literal block.
There was a problem hiding this comment.
Hm, actually in plain Sphinx this works fine. The following is rendered as expected:
Demo code: ``hi``
Demo code: `````
Demo code: ``\```
Demo code: ```hi```
Demo code: ````hi````
Demo code: ``meta: ``hi````
ashb
approved these changes
May 1, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Helps to fix #15