rest2html: treat referenced wrapped images in base document as inlined#1935
rest2html: treat referenced wrapped images in base document as inlined#1935jdknight wants to merge 1 commit intogithub:masterfrom
Conversation
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. Signed-off-by: James Knight <git@jdknight.me>
|
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. |
|
!unstale |
|
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. |
|
!unstale |
|
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. |
|
!unstale |
|
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. |
|
!unstale |
|
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. |
2 participants
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
TextElementto consider it inlined. Since a document is not aTextElementtype, 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.rstshows this issue:With the changes made in this merge request, the following shows a rendering of HTML before and after the change: