Skip to content

bpo-38022: IDLE: upgrade help.html to sphinx 2.x HTML5 output#15664

Merged
terryjreedy merged 1 commit intopython:masterfrom
taleinat:bpo-38022/idle-help-html-upgrade
Sep 3, 2019
Merged

bpo-38022: IDLE: upgrade help.html to sphinx 2.x HTML5 output#15664
terryjreedy merged 1 commit intopython:masterfrom
taleinat:bpo-38022/idle-help-html-upgrade

Conversation

@taleinat
Copy link
Copy Markdown
Contributor

@taleinat taleinat commented Sep 3, 2019

This is done by making HelpParser properly handle the slightly different HTML. This required two changes:

  1. Avoid additional empty lines for <p> tags inside list items (e.g. <li>). This is achieved by avoiding starting a new block of text for <p> tags if they come after an opening tag.
  2. Avoid an extra empty line after <pre> tags. This is requried because <pre> tags need a newline at the end for them to be displayed properly. Achieved by adding only a single newline if the previous line is empty or entirely white-space.

Also, note the removal of the class_ != 'first' check for <p> tags. This is because the new HTML output no longer includes "first" classes on tags.

https://bugs.python.org/issue38022

Copy link
Copy Markdown
Member

@terryjreedy terryjreedy left a comment

Choose a reason for hiding this comment

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

Thank you for this. I compared new output to 3.8 and the only change is the fix of not double spacing after code (pre) blocks. The code change is clear. I will merge and backport.

# I will follow with a separate no-issue, no-news PR to fix comments with caps and periods.

@terryjreedy terryjreedy merged commit 580bdb0 into python:master Sep 3, 2019
@miss-islington
Copy link
Copy Markdown
Contributor

Thanks @taleinat for the PR, and @terryjreedy for merging it 🌮🎉.. I'm working now to backport this PR to: 3.7, 3.8.
🐍🍒⛏🤖

@miss-islington
Copy link
Copy Markdown
Contributor

I'm having trouble backporting to 3.8. Reason: 'Error 110 while writing to socket. Connection timed out.'. Please retry by removing and re-adding the needs backport to 3.8 label.

@bedevere-bot
Copy link
Copy Markdown

GH-15667 is a backport of this pull request to the 3.7 branch.

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Sep 3, 2019
…GH-15664)

The HTML5 output from Sphinx 2.x adds  '<p>' tags within list elements.  Using a new prevtag attribute, ignore these instead of emitting unwanted '\n\n'.

Also stop looking for 'first' classes on tags (no longer present) and fix the bug of double-spacing instead of single spacing after <pre> blocks.
(cherry picked from commit 580bdb0)

Co-authored-by: Tal Einat <taleinat+github@gmail.com>
@miss-islington
Copy link
Copy Markdown
Contributor

Thanks @taleinat for the PR, and @terryjreedy for merging it 🌮🎉.. I'm working now to backport this PR to: 3.8.
🐍🍒⛏🤖

@bedevere-bot
Copy link
Copy Markdown

GH-15668 is a backport of this pull request to the 3.8 branch.

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Sep 3, 2019
…GH-15664)

The HTML5 output from Sphinx 2.x adds  '<p>' tags within list elements.  Using a new prevtag attribute, ignore these instead of emitting unwanted '\n\n'.

Also stop looking for 'first' classes on tags (no longer present) and fix the bug of double-spacing instead of single spacing after <pre> blocks.
(cherry picked from commit 580bdb0)

Co-authored-by: Tal Einat <taleinat+github@gmail.com>
@miss-islington
Copy link
Copy Markdown
Contributor

Thanks @taleinat for the PR, and @terryjreedy for merging it 🌮🎉.. I'm working now to backport this PR to: 3.8.
🐍🍒⛏🤖

miss-islington added a commit that referenced this pull request Sep 3, 2019
The HTML5 output from Sphinx 2.x adds  '<p>' tags within list elements.  Using a new prevtag attribute, ignore these instead of emitting unwanted '\n\n'.

Also stop looking for 'first' classes on tags (no longer present) and fix the bug of double-spacing instead of single spacing after <pre> blocks.
(cherry picked from commit 580bdb0)

Co-authored-by: Tal Einat <taleinat+github@gmail.com>
miss-islington added a commit that referenced this pull request Sep 3, 2019
The HTML5 output from Sphinx 2.x adds  '<p>' tags within list elements.  Using a new prevtag attribute, ignore these instead of emitting unwanted '\n\n'.

Also stop looking for 'first' classes on tags (no longer present) and fix the bug of double-spacing instead of single spacing after <pre> blocks.
(cherry picked from commit 580bdb0)

Co-authored-by: Tal Einat <taleinat+github@gmail.com>
lisroach pushed a commit to lisroach/cpython that referenced this pull request Sep 10, 2019
…GH-15664)

The HTML5 output from Sphinx 2.x adds  '<p>' tags within list elements.  Using a new prevtag attribute, ignore these instead of emitting unwanted '\n\n'.

Also stop looking for 'first' classes on tags (no longer present) and fix the bug of double-spacing instead of single spacing after <pre> blocks.
DinoV pushed a commit to DinoV/cpython that referenced this pull request Jan 14, 2020
…GH-15664)

The HTML5 output from Sphinx 2.x adds  '<p>' tags within list elements.  Using a new prevtag attribute, ignore these instead of emitting unwanted '\n\n'.

Also stop looking for 'first' classes on tags (no longer present) and fix the bug of double-spacing instead of single spacing after <pre> blocks.
websurfer5 pushed a commit to websurfer5/cpython that referenced this pull request Jul 20, 2020
…GH-15664)

The HTML5 output from Sphinx 2.x adds  '<p>' tags within list elements.  Using a new prevtag attribute, ignore these instead of emitting unwanted '\n\n'.

Also stop looking for 'first' classes on tags (no longer present) and fix the bug of double-spacing instead of single spacing after <pre> blocks.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

skip news type-feature A feature request or enhancement

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants