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

Automate creation of idlelib/help.html from Doc/.../idle.html #69405

Open
terryjreedy opened this issue Sep 23, 2015 · 2 comments
Open

Automate creation of idlelib/help.html from Doc/.../idle.html #69405

terryjreedy opened this issue Sep 23, 2015 · 2 comments
Assignees
@terryjreedy
Labels
3.7 (EOL) end of life build The build process and cross-build docs Documentation in the Doc dir topic-IDLE type-bug An unexpected behavior, bug, or error

Comments

@terryjreedy
Copy link
Member

BPO 25218
Nosy @terryjreedy, @zware

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 = None
created_at = <Date 2015-09-23.03:42:34.985>
labels = ['expert-IDLE', 'type-bug', '3.7', 'build']
title = 'Automate creation of idlelib/help.html from Doc/.../idle.html'
updated_at = <Date 2017-09-11.20:55:28.824>
user = 'https://github.com/terryjreedy'

bugs.python.org fields:

activity = <Date 2017-09-11.20:55:28.824>
actor = 'terry.reedy'
assignee = 'terry.reedy'
closed = False
closed_date = None
closer = None
components = ['Build', 'IDLE']
creation = <Date 2015-09-23.03:42:34.985>
creator = 'terry.reedy'
dependencies = []
files = []
hgrepos = []
issue_num = 25218
keywords = []
message_count = 2.0
messages = ['251402', '301902']
nosy_count = 2.0
nosy_names = ['terry.reedy', 'zach.ware']
pr_nums = []
priority = 'normal'
resolution = None
stage = 'needs patch'
status = 'open'
superseder = None
type = 'behavior'
url = 'https://bugs.python.org/issue25218'
versions = ['Python 3.6', 'Python 3.7']
@terryjreedy
Copy link
Member Author

This continues bpo-16893, which replaced help.txt with help.html for the Idle doc display. It also replaced the display classes with new classes in help.py. I currently create help.html in a .bat file. With Doc as current directory, it uses
..\pcbuild\python_d.exe -c "from idlelib.help import copy_strip; copy_strip()"
With a change to the help.py if __name__ block so that
..\pcbuild\python_d.exe -m idlelib.help copy_strip
would work.

This issue is first about revising Zack Ware's makefile patch, https://bugs.python.org/file36975/issue16893-v4.diff, which adds an 'idledoc' target. It is attached to bpo-16893. It needs 'copy' replaced by 'copy, strip, and rename'. The command above requires finding a compatible python.exe, and I do not know if that is a problem.

In normal use, 'idledoc' should only be invoked for the earliest 3.x getting maintenance patches, and the result merged forward.

If this is resolved, it would be nice if the new 'idledoc' target were built as apart of the release process, and any changes checked in. But the latter should currently still be done for all 3.x branches

@terryjreedy terryjreedy self-assigned this Sep 23, 2015
@terryjreedy terryjreedy added the type-bug An unexpected behavior, bug, or error label Sep 23, 2015
@terryjreedy terryjreedy added build The build process and cross-build topic-IDLE labels Jun 19, 2017
@terryjreedy
Copy link
Member Author

Zach, I currently build idlelib/help.html by first building a complete doc set and then copying from Doc/.../idle.html, stripping trailing whitespace on the say. One problem is that the result has a lot of extraneous stuff aside from the doc text itself: the code for the header, sidebar, and footer. These are a nuisance when committing changes and for extracting just the text we want.

I would prefer to create a clean .html from Doc/library/idle.rst that just has the code for the doc, without the extraneous matter. Do you know how? I looked in Doc/make.bat and it says it will not work on single files.

@terryjreedy terryjreedy added the 3.7 (EOL) end of life label Sep 11, 2017
@ezio-melotti ezio-melotti transferred this issue from another repository Apr 10, 2022
@erlend-aasland erlend-aasland added the docs Documentation in the Doc dir label Jul 27, 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 build The build process and cross-build docs Documentation in the Doc dir topic-IDLE type-bug An unexpected behavior, bug, or error
Projects
IDLE Issues
Status: No status
Milestone
No milestone
Development

No branches or pull requests
2 participants
@erlend-aasland @terryjreedy