markup icon indicating copy to clipboard operation
markup copied to clipboard

rest2html: treat referenced wrapped images in base document as inlined

Open jdknight opened this issue 10 months ago • 6 comments

docutils will only add newlines around images it believes are inlined. For images held in references, it checks the parent of the reference if its a TextElement to consider it inlined. Since a document is not a TextElement type, it will wrap an image with newlines. For GitHub output, this is not desired and will result in the extra whitespace being rendered with a reference's decorative line. To avoid this, always strip any appended suffixes for images in this scenario.


There are a various GitHub projects which reveal the issue. For example, Sphinx's README.rst shows this issue:

With the changes made in this merge request, the following shows a rendering of HTML before and after the change:

jdknight avatar Mar 04 '25 02:03 jdknight

This pull request has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

github-actions[bot] avatar Jul 02 '25 12:07 github-actions[bot]

!unstale

jdknight avatar Jul 03 '25 01:07 jdknight

This pull request has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

github-actions[bot] avatar Sep 01 '25 12:09 github-actions[bot]

!unstale

jdknight avatar Sep 01 '25 13:09 jdknight

This pull request has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

github-actions[bot] avatar Nov 02 '25 12:11 github-actions[bot]

!unstale

jdknight avatar Nov 02 '25 15:11 jdknight