Skip to content

Add information about IDLE to online contents #129699

Closed

Description

@StanFromIreland

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

Activity

  1. changed the title [-]Add information about IDLE in stdlib[/-] [+]Add information about IDLE in stdlib index[/+] on Feb 5, 2025
  2. added this to IDLE Issues and removed this from docs issueson Feb 6, 2025
  3. terryjreedy commented on Feb 6, 2025

    @terryjreedy
    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.

  4. changed the title [-]Add information about IDLE in stdlib index[/-] [+]Add information about IDLE to online contents[/+] on Feb 7, 2025
  5. added a commit that references this issue on Feb 8, 2025
  6. added 2 commits that reference this issue on Feb 8, 2025
  7. added 2 commits that reference this issue on Feb 8, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    docsDocumentation in the Doc dirtopic-IDLEtype-featureA feature request or enhancement

    Projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions