Skip to content

Add information about IDLE to online contents #129699

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.

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

Closed
StanFromIreland opened this issue Feb 5, 2025 · 1 comment
Closed

Add information about IDLE to online contents #129699

StanFromIreland opened this issue Feb 5, 2025 · 1 comment
Labels
docs Documentation in the Doc dir topic-IDLE type-feature A feature request or enhancement

Comments

@StanFromIreland
Copy link
Contributor

StanFromIreland commented Feb 5, 2025

Clicking Complete table of contents on docs.python.org shows, in part,

Image

A short line like:

Python's Integrated Development Environment

Maybe the remainder can be omitted?

@terryjreedy

Linked PRs

@StanFromIreland StanFromIreland added the docs Documentation in the Doc dir label Feb 5, 2025
@StanFromIreland StanFromIreland changed the title Add information about IDLE in stdlib Add information about IDLE in stdlib index Feb 5, 2025
@terryjreedy terryjreedy removed this from docs issues Feb 6, 2025
@terryjreedy
Copy link
Member

This master html content index file is generated from the individual files when the doc set is created by Sphinx. The entries are derived from the header lines. Omitting other markup, tkinter.rst begins with "tkinter --- Python interface to Tcl/Tk", the same as above with --- converted to the continuous line. I suggest we add --- Python editor and shell to the title of Doc/library/idle.rst. Near the bottom of the file, we could expand the subsubsection 'idlelib' to idlelib --- implementation of IDLE application. Either suggest other additions to add or go ahead with a PR if you want.

For the module index py-modindex.html, accessed by clicking the top right button on the online pages, the extra explanation is the module synopsis. tkinter.rst has :synopsis: Interface to Tcl/Tk for graphical user interfaces. This seems only to be applicable to modules. Since IDLE is not a module, 'IDLE' does not belong there, which is why I added the idlelib section, with a synopsis.

@encukou encukou added the type-feature A feature request or enhancement label Feb 6, 2025
@terryjreedy terryjreedy changed the title Add information about IDLE in stdlib index Add information about IDLE to online contents Feb 7, 2025
@terryjreedy terryjreedy removed this from docs issues Feb 8, 2025
terryjreedy added a commit that referenced this issue Feb 8, 2025
Also extend the 'idlelib' section header. These additions affect both the displayed idle.html file and the contents.html file displayed by clicking the Complete table of contents link on the main docs.python.org page. (The module index entries are generated from the module name and synopsis within module files.)
---------

Co-authored-by: Terry Jan Reedy <[email protected]>
miss-islington pushed a commit to miss-islington/cpython that referenced this issue Feb 8, 2025
Also extend the 'idlelib' section header. These additions affect both the displayed idle.html file and the contents.html file displayed by clicking the Complete table of contents link on the main docs.python.org page. (The module index entries are generated from the module name and synopsis within module files.)
---------

(cherry picked from commit 33a7094)

Co-authored-by: Stan Ulbrych <[email protected]>
Co-authored-by: Terry Jan Reedy <[email protected]>
miss-islington pushed a commit to miss-islington/cpython that referenced this issue Feb 8, 2025
Also extend the 'idlelib' section header. These additions affect both the displayed idle.html file and the contents.html file displayed by clicking the Complete table of contents link on the main docs.python.org page. (The module index entries are generated from the module name and synopsis within module files.)
---------

(cherry picked from commit 33a7094)

Co-authored-by: Stan Ulbrych <[email protected]>
Co-authored-by: Terry Jan Reedy <[email protected]>
terryjreedy added a commit that referenced this issue Feb 8, 2025
)

gh-129699: Add description to IDLE doc title (GH-129727)

Also extend the 'idlelib' section header. These additions affect both the displayed idle.html file and the contents.html file displayed by clicking the Complete table of contents link on the main docs.python.org page. (The module index entries are generated from the module name and synopsis within module files.)
---------

(cherry picked from commit 33a7094)

Co-authored-by: Stan Ulbrych <[email protected]>
Co-authored-by: Terry Jan Reedy <[email protected]>
terryjreedy added a commit that referenced this issue Feb 8, 2025
)

gh-129699: Add description to IDLE doc title (GH-129727)

Also extend the 'idlelib' section header. These additions affect both the displayed idle.html file and the contents.html file displayed by clicking the Complete table of contents link on the main docs.python.org page. (The module index entries are generated from the module name and synopsis within module files.)
---------

(cherry picked from commit 33a7094)

Co-authored-by: Stan Ulbrych <[email protected]>
Co-authored-by: Terry Jan Reedy <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation in the Doc dir topic-IDLE type-feature A feature request or enhancement
Projects
Status: Done
Development

No branches or pull requests

3 participants