Skip to content

Commit c6aa68f

Browse files
gh-75500: Add idlelib section to IDLE doc (GH-95832)
This enables accessing IDLE as 'idlelib' in the Doc Module listing. (cherry picked from commit 70fc964) Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
1 parent 1a22ec5 commit c6aa68f

File tree

2 files changed

+31
-1
lines changed

2 files changed

+31
-1
lines changed

Doc/library/idle.rst

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -983,3 +983,20 @@ changed with the Extensions tab of the preferences dialog. See the
983983
beginning of config-extensions.def in the idlelib directory for further
984984
information. The only current default extension is zzdummy, an example
985985
also used for testing.
986+
987+
idlelib
988+
^^^^^^^
989+
990+
.. module:: idlelib
991+
:synopsis: Implementation package for the IDLE shell/editor.
992+
993+
**Source code:** :source:`Lib/idlelib`
994+
995+
The Lib/idlelib package implements the IDLE application. See the top
996+
of this file or content listing on the left for how to use IDLE.
997+
998+
The files in idlelib are described in idlelib/README.txt. Access it
999+
either in idlelib or click Help => About IDLE on the IDLE menu. This
1000+
file also maps IDLE menu items to the code that implements the item.
1001+
Except for files listed under 'Startup', the idlelib code is 'private' in
1002+
sense that feature changes can be backported (see :pep:`434`).

Lib/idlelib/help.html

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -113,6 +113,7 @@ <h3><a href="../contents.html">Table of Contents</a></h3>
113113
<li><a class="reference internal" href="#setting-preferences">Setting preferences</a></li>
114114
<li><a class="reference internal" href="#idle-on-macos">IDLE on macOS</a></li>
115115
<li><a class="reference internal" href="#extensions">Extensions</a></li>
116+
<li><a class="reference internal" href="#module-idlelib">idlelib</a></li>
116117
</ul>
117118
</li>
118119
</ul>
@@ -1001,6 +1002,17 @@ <h3>Extensions<a class="headerlink" href="#extensions" title="Permalink to this
10011002
information. The only current default extension is zzdummy, an example
10021003
also used for testing.</p>
10031004
</section>
1005+
<section id="module-idlelib">
1006+
<span id="idlelib"></span><h3>idlelib<a class="headerlink" href="#module-idlelib" title="Permalink to this heading"></a></h3>
1007+
<p><strong>Source code:</strong> <a class="reference external" href="https://github.com/python/cpython/tree/main/Lib/idlelib">Lib/idlelib</a></p>
1008+
<p>The Lib/idlelib package implements the IDLE application. See the top
1009+
of this file or content listing on the left for how to use IDLE.</p>
1010+
<p>The files in idlelib are described in idlelib/README.txt. Access it
1011+
either in idlelib or click Help =&gt; About IDLE on the IDLE menu. This
1012+
file also maps IDLE menu items to the code that implements the item.
1013+
Except for files listed under ‘Startup’, the idlelib code is ‘private’ in
1014+
sense that feature changes can be backported (see <span class="target" id="index-7"></span><a class="pep reference external" href="https://peps.python.org/pep-0434/"><strong>PEP 434</strong></a>).</p>
1015+
</section>
10041016
</section>
10051017
</section>
10061018

@@ -1054,6 +1066,7 @@ <h3><a href="../contents.html">Table of Contents</a></h3>
10541066
<li><a class="reference internal" href="#setting-preferences">Setting preferences</a></li>
10551067
<li><a class="reference internal" href="#idle-on-macos">IDLE on macOS</a></li>
10561068
<li><a class="reference internal" href="#extensions">Extensions</a></li>
1069+
<li><a class="reference internal" href="#module-idlelib">idlelib</a></li>
10571070
</ul>
10581071
</li>
10591072
</ul>
@@ -1153,7 +1166,7 @@ <h3>Navigation</h3>
11531166
<br />
11541167
<br />
11551168

1156-
Last updated on Aug 05, 2022.
1169+
Last updated on Aug 07, 2022.
11571170
<a href="/bugs.html">Found a bug</a>?
11581171
<br />
11591172

0 commit comments

Comments
 (0)