Skip to content

rest2html: treat referenced wrapped images in base document as inlined#1935

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.

Sign up for GitHub

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

Open
jdknight wants to merge 2 commits into
base:master
Choose a base branch
from
+18 −0
Open

rest2html: treat referenced wrapped images in base document as inlined #1935

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4610a00
rest2html: treat referenced wrapped images in base document as inlined
jdknight Mar 4, 2025
2d7048a
test: validate inlined rst references do not add whitespaces
jdknight Jun 13, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions lib/github/commands/rest2html
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -258,6 +258,12 @@ class GitHubHTMLTranslator(HTMLTranslator):
self.body.append(self.starttag(node, 'img', **atts))
HTMLTranslator.depart_image(self, node)

# treat images held in a reference on the base document as inlined
# images; this is to help avoid rendering a reference's decorative
# line for the spacing after an image
if (isinstance(node.parent, nodes.reference)
and isinstance(node.parent.parent, nodes.document)):
self.body.append(self.body.pop().rstrip('\n'))
Comment on lines +261 to +266

CopilotAIApr 22, 2026

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This change adjusts HTML whitespace semantics in a subtle way, but the existing markup tests normalize/strip blank text nodes via Nokogiri (noblanks), so they likely won’t fail if the newline/whitespace regresses. Consider adding a targeted regression test that asserts the raw HTML output for a top-level .. image:: with :target: does not contain whitespace between the <img> and the closing </a> (string-level assertion, not DOM-equality).

Copilot uses AI. Check for mistakes.

def kbd(name, rawtext, text, lineno, inliner, options={}, content=[]):
return [nodes.raw('', '<kbd>%s</kbd>' % text, format='html')], []
Expand Down
12 changes: 12 additions & 0 deletions test/markup_test.rb
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -137,4 +137,16 @@ def test_commonmarker_options
assert_equal "&lt;style>.red{color: red;}&lt;/style>\n", GitHub::Markup.render_s(GitHub::Markups::MARKUP_MARKDOWN, "<style>.red{color: red;}</style>", options: {commonmarker_opts: [:UNSAFE]})
assert_equal "<style>.red{color: red;}</style>\n", GitHub::Markup.render_s(GitHub::Markups::MARKUP_MARKDOWN, "<style>.red{color: red;}</style>", options: {commonmarker_opts: [:UNSAFE], commonmarker_exts: [:autolink, :table, :strikethrough]})
end

def test_blanks_rst_inlined_reference
expected = '<img src="https://example.com/img.svg"></a>'

actual = GitHub::Markup.render_s(GitHub::Markups::MARKUP_RST, <<~RST
.. image:: https://example.com/img.svg
:target: https://example.com/
RST
)

assert_equal expected, actual.strip.lines.last
end
end