Skip to content
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

Jump to bottom

IDLE: update idlelib help files for current doc build #79268

Closed
terryjreedy opened this issue Oct 28, 2018 · 4 comments
Closed

IDLE: update idlelib help files for current doc build #79268

terryjreedy opened this issue Oct 28, 2018 · 4 comments
Assignees
@terryjreedy
Labels
3.7 (EOL) end of life 3.8 only security fixes topic-IDLE type-bug An unexpected behavior, bug, or error

Comments

@terryjreedy
Copy link
Member

BPO 35087
Nosy @terryjreedy, @miss-islington
PRs
  • bpo-35087: Update idlelib help files for the current doc build. #10162
  • [3.7] bpo-35087: Update idlelib help files for the current doc build. (GH-10162) #10165
  • [3.6] bpo-35087: Update idlelib help files for the current doc build. (GH-10162) #10166
    		•

    Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.

    Show more details

    GitHub fields:

    assignee = 'https://github.com/terryjreedy'
closed_at = <Date 2018-10-28.07:35:12.941>
created_at = <Date 2018-10-28.03:16:45.684>
labels = ['3.8', 'expert-IDLE', 'type-bug', '3.7']
title = 'IDLE: update idlelib help files for current doc build'
updated_at = <Date 2018-10-28.07:35:12.940>
user = 'https://github.com/terryjreedy'

    bugs.python.org fields:

    activity = <Date 2018-10-28.07:35:12.940>
actor = 'terry.reedy'
assignee = 'terry.reedy'
closed = True
closed_date = <Date 2018-10-28.07:35:12.941>
closer = 'terry.reedy'
components = ['IDLE']
creation = <Date 2018-10-28.03:16:45.684>
creator = 'terry.reedy'
dependencies = []
files = []
hgrepos = []
issue_num = 35087
keywords = ['patch']
message_count = 4.0
messages = ['328670', '328672', '328675', '328676']
nosy_count = 2.0
nosy_names = ['terry.reedy', 'miss-islington']
pr_nums = ['10162', '10165', '10166']
priority = 'normal'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = 'behavior'
url = 'https://bugs.python.org/issue35087'
versions = ['Python 3.6', 'Python 3.7', 'Python 3.8']
    @terryjreedy
    Copy link
    Member Author

    https://docs.python.org/3.6/library/idle.html starts with '25.5 IDLE'.
    https://docs.python.org/3.7/library/idle.html starts with 'IDLE'.
    The chapter and sections numbers are gone.

    The current idlelib/help.html was copied (and stripped) from a Doc/build/library/idle.html built from the current Doc/library/idle.rst with Sphinx 1.7.4. It was merged 2018 June 10. See bpo-33610. Headers have chapter-section numbers. (The chapter number is detected on the first line and removed from all headers before display.)

    When I changed idle.rst on a branch of master and rebuilt the docs with 1.7.4, there were over 100 warnings about an unknown doctest directive 'skipif'. When I upgraded to Sphinx 1.8.1, the warnings disappeared, and so did the chapter-section numbers. So it appears that the 3.7+ docs are meant to be built, and 3.7+ online docs are being built, with the newer Sphinx. I am not sure of whether the loss of numbers is intentional and permanent, but for the present, I will use the 1.8 versions of idle.html and the derived help.html. idlelib/help.html is currently the same for all of 3.6 to 3.8, so one diff can be merged and back-ported.

    help.py is also the same for all 3 versions. But the loss of numbers breaks it. The upcoming patch will also fix this (but not immediately delete the code that handles numbers. For the moment, I will replace the numbers in the Table of Contents with indents.

    @terryjreedy terryjreedy added 3.7 (EOL) end of life 3.8 only security fixes labels Oct 28, 2018
    @terryjreedy terryjreedy self-assigned this Oct 28, 2018
    @terryjreedy terryjreedy added topic-IDLE type-bug An unexpected behavior, bug, or error labels Oct 28, 2018
    @terryjreedy
    Copy link
    Member Author

    New changeset db40cb5 by Terry Jan Reedy in branch 'master':
    bpo-35087: Update idlelib help files for the current doc build. (GH-10162)
    db40cb5

    @miss-islington
    Copy link
    Contributor

    New changeset 2d3b7a9 by Miss Islington (bot) in branch '3.7':
    bpo-35087: Update idlelib help files for the current doc build. (GH-10162)
    2d3b7a9

    @miss-islington
    Copy link
    Contributor

    New changeset 0995314 by Miss Islington (bot) in branch '3.6':
    bpo-35087: Update idlelib help files for the current doc build. (GH-10162)
    0995314

    @ezio-melotti ezio-melotti transferred this issue from another repository Apr 10, 2022
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Assignees

    @terryjreedy terryjreedy

    Labels
    3.7 (EOL) end of life 3.8 only security fixes topic-IDLE type-bug An unexpected behavior, bug, or error
    Projects
    None yet
    Milestone
    No milestone
    Development

    No branches or pull requests
    2 participants
    @terryjreedy @miss-islington