mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-07-24 19:54:21 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 8

gh-75500: Add idlelib section to IDLE doc (#95832)

Browse source 
This enables accessing IDLE as 'idlelib' in the Doc Module listing.
This commit is contained in:
Terry Jan Reedy 2022-08-09 14:34:42 -04:00 • committed by GitHub
parent 141f2517fc
commit 70fc9641b5
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 31 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

17
Doc/library/idle.rst
View file

@ -983,3 +983,20 @@ changed with the Extensions tab of the preferences dialog. See the
beginning of config-extensions.def in the idlelib directory for further
information. The only current default extension is zzdummy, an example
also used for testing.
idlelib
^^^^^^^
.. module:: idlelib
:synopsis: Implementation package for the IDLE shell/editor.
**Source code:** :source:`Lib/idlelib`
The Lib/idlelib package implements the IDLE application. See the top
of this file or content listing on the left for how to use IDLE.
The files in idlelib are described in idlelib/README.txt. Access it
either in idlelib or click Help => About IDLE on the IDLE menu. This
file also maps IDLE menu items to the code that implements the item.
Except for files listed under 'Startup', the idlelib code is 'private' in
sense that feature changes can be backported (see :pep:`434`).

15
Lib/idlelib/help.html
View file

@ -113,6 +113,7 @@
<li><a class="reference internal" href="#setting-preferences">Setting preferences</a></li>
<li><a class="reference internal" href="#idle-on-macos">IDLE on macOS</a></li>
<li><a class="reference internal" href="#extensions">Extensions</a></li>
<li><a class="reference internal" href="#module-idlelib">idlelib</a></li>
</ul>
</li>
</ul>
@ -1001,6 +1002,17 @@ beginning of config-extensions.def in the idlelib directory for further
information. The only current default extension is zzdummy, an example
also used for testing.</p>
</section>
<section id="module-idlelib">
<span id="idlelib"></span><h3>idlelib<a class="headerlink" href="#module-idlelib" title="Permalink to this heading"></a></h3>
<p><strong>Source code:</strong> <a class="reference external" href="https://github.com/python/cpython/tree/main/Lib/idlelib">Lib/idlelib</a></p>
<p>The Lib/idlelib package implements the IDLE application. See the top
of this file or content listing on the left for how to use IDLE.</p>
<p>The files in idlelib are described in idlelib/README.txt. Access it
either in idlelib or click Help =&gt; About IDLE on the IDLE menu. This
file also maps IDLE menu items to the code that implements the item.
Except for files listed under ‘Startup’, the idlelib code is ‘private’ in
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>
</section>
</section>
</section>
@ -1054,6 +1066,7 @@ also used for testing.</p>
<li><a class="reference internal" href="#setting-preferences">Setting preferences</a></li>
<li><a class="reference internal" href="#idle-on-macos">IDLE on macOS</a></li>
<li><a class="reference internal" href="#extensions">Extensions</a></li>
<li><a class="reference internal" href="#module-idlelib">idlelib</a></li>
</ul>
</li>
</ul>
@ -1153,7 +1166,7 @@ also used for testing.</p>
<br />
<br />
Last updated on Aug 05, 2022.
Last updated on Aug 07, 2022.
<a href="/bugs.html">Found a bug</a>?
<br />