classification
Title: IDLE: update idlelib help files for current doc build
Type: behavior Stage: resolved
Components: IDLE Versions: Python 3.8, Python 3.7, Python 3.6
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: terry.reedy Nosy List: miss-islington, terry.reedy
Priority: normal Keywords: patch

Created on 2018-10-28 03:16 by terry.reedy, last changed 2018-10-28 07:35 by terry.reedy. This issue is now closed.

Pull Requests
URL Status Linked Edit
PR 10162 merged terry.reedy, 2018-10-28 04:18
PR 10165 merged miss-islington, 2018-10-28 05:21
PR 10166 merged miss-islington, 2018-10-28 05:22
Messages (4)
msg328670 - (view) Author: Terry J. Reedy (terry.reedy) * (Python committer) Date: 2018-10-28 03:16
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 #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.
msg328672 - (view) Author: Terry J. Reedy (terry.reedy) * (Python committer) Date: 2018-10-28 05:21
New changeset db40cb50eb823b8ef9040b1c9bf31a7475d94d39 by Terry Jan Reedy in branch 'master':
bpo-35087: Update idlelib help files for the current doc build. (GH-10162)
https://github.com/python/cpython/commit/db40cb50eb823b8ef9040b1c9bf31a7475d94d39
msg328675 - (view) Author: miss-islington (miss-islington) Date: 2018-10-28 05:40
New changeset 2d3b7a99635b10873fdd6da01dcb7cfb33837633 by Miss Islington (bot) in branch '3.7':
bpo-35087: Update idlelib help files for the current doc build. (GH-10162)
https://github.com/python/cpython/commit/2d3b7a99635b10873fdd6da01dcb7cfb33837633
msg328676 - (view) Author: miss-islington (miss-islington) Date: 2018-10-28 05:42
New changeset 09953141b9eb4c42fdf366d084f4f328ddbc0dc8 by Miss Islington (bot) in branch '3.6':
bpo-35087: Update idlelib help files for the current doc build. (GH-10162)
https://github.com/python/cpython/commit/09953141b9eb4c42fdf366d084f4f328ddbc0dc8
History
Date User Action Args
2018-10-28 07:35:12terry.reedysetstatus: open -> closed
resolution: fixed
stage: patch review -> resolved
2018-10-28 05:42:52miss-islingtonsetmessages: + msg328676
2018-10-28 05:40:05miss-islingtonsetnosy: + miss-islington
messages: + msg328675
2018-10-28 05:22:06miss-islingtonsetpull_requests: + pull_request9489
2018-10-28 05:21:53miss-islingtonsetpull_requests: + pull_request9488
2018-10-28 05:21:40terry.reedysetmessages: + msg328672
2018-10-28 04:18:44terry.reedysetkeywords: + patch
stage: needs patch -> patch review
pull_requests: + pull_request9485
2018-10-28 03:16:45terry.reedycreate