Skip to content

Docs: remove links of modules to themselves #144695

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.

Sign up for GitHub

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

Merged
nedbat merged 1 commit into from
Feb 11, 2026
+167 −167
Merged

Docs: remove links of modules to themselves #144695

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 9 additions & 9 deletions Doc/library/codecs.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1551,8 +1551,8 @@ mapping. It is not supported by :meth:`str.encode` (which only produces
Restoration of the ``rot13`` alias.


:mod:`encodings` --- Encodings package
--------------------------------------
:mod:`!encodings` --- Encodings package
---------------------------------------

.. module:: encodings
:synopsis: Encodings package
Expand Down Expand Up @@ -1611,8 +1611,8 @@ This module implements the following exception:
Raised when a codec is invalid or incompatible.


:mod:`encodings.idna` --- Internationalized Domain Names in Applications
------------------------------------------------------------------------
:mod:`!encodings.idna` --- Internationalized Domain Names in Applications
-------------------------------------------------------------------------

.. module:: encodings.idna
:synopsis: Internationalized Domain Names implementation
Expand Down Expand Up @@ -1654,7 +1654,7 @@ When receiving host names from the wire (such as in reverse name lookup), no
automatic conversion to Unicode is performed: applications wishing to present
such host names to the user should decode them to Unicode.

The module :mod:`encodings.idna` also implements the nameprep procedure, which
The module :mod:`!encodings.idna` also implements the nameprep procedure, which
performs certain normalizations on host names, to achieve case-insensitivity of
international domain names, and to unify similar characters. The nameprep
functions can be used directly if desired.
Expand All @@ -1677,8 +1677,8 @@ functions can be used directly if desired.
Convert a label to Unicode, as specified in :rfc:`3490`.


:mod:`encodings.mbcs` --- Windows ANSI codepage
-----------------------------------------------
:mod:`!encodings.mbcs` --- Windows ANSI codepage
------------------------------------------------

.. module:: encodings.mbcs
:synopsis: Windows ANSI codepage
Expand All @@ -1695,8 +1695,8 @@ This module implements the ANSI codepage (CP_ACP).
Support any error handler.


:mod:`encodings.utf_8_sig` --- UTF-8 codec with BOM signature
-------------------------------------------------------------
:mod:`!encodings.utf_8_sig` --- UTF-8 codec with BOM signature
--------------------------------------------------------------

.. module:: encodings.utf_8_sig
:synopsis: UTF-8 codec with BOM signature
Expand Down
8 changes: 4 additions & 4 deletions Doc/library/curses.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1824,22 +1824,22 @@ The following table lists the predefined colors:
+-------------------------+----------------------------+


:mod:`curses.textpad` --- Text input widget for curses programs
===============================================================
:mod:`!curses.textpad` --- Text input widget for curses programs
================================================================

.. module:: curses.textpad
:synopsis: Emacs-like input editing in a curses window.
.. moduleauthor:: Eric Raymond <esr@thyrsus.com>
.. sectionauthor:: Eric Raymond <esr@thyrsus.com>


The :mod:`curses.textpad` module provides a :class:`Textbox` class that handles
The :mod:`!curses.textpad` module provides a :class:`Textbox` class that handles
elementary text editing in a curses window, supporting a set of keybindings
resembling those of Emacs (thus, also of Netscape Navigator, BBedit 6.x,
FrameMaker, and many other programs). The module also provides a
rectangle-drawing function useful for framing text boxes or for other purposes.

The module :mod:`curses.textpad` defines the following function:
The module :mod:`!curses.textpad` defines the following function:


.. function:: rectangle(win, uly, ulx, lry, lrx)
Expand Down
40 changes: 20 additions & 20 deletions Doc/library/dbm.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -157,8 +157,8 @@ then prints out the contents of the database::

The individual submodules are described in the following sections.

:mod:`dbm.sqlite3` --- SQLite backend for dbm
---------------------------------------------
:mod:`!dbm.sqlite3` --- SQLite backend for dbm
----------------------------------------------

.. module:: dbm.sqlite3
:platform: All
Expand All @@ -172,7 +172,7 @@ The individual submodules are described in the following sections.

This module uses the standard library :mod:`sqlite3` module to provide an
SQLite backend for the :mod:`!dbm` module.
The files created by :mod:`dbm.sqlite3` can thus be opened by :mod:`sqlite3`,
The files created by :mod:`!dbm.sqlite3` can thus be opened by :mod:`sqlite3`,
or any other SQLite browser, including the SQLite CLI.

.. include:: ../includes/wasm-notavail.rst
Expand Down Expand Up @@ -220,8 +220,8 @@ or any other SQLite browser, including the SQLite CLI.
.. versionadded:: 3.15


:mod:`dbm.gnu` --- GNU database manager
---------------------------------------
:mod:`!dbm.gnu` --- GNU database manager
----------------------------------------

.. module:: dbm.gnu
:platform: Unix
Expand All @@ -231,20 +231,20 @@ or any other SQLite browser, including the SQLite CLI.

--------------

The :mod:`dbm.gnu` module provides an interface to the :abbr:`GDBM (GNU dbm)`
The :mod:`!dbm.gnu` module provides an interface to the :abbr:`GDBM (GNU dbm)`
library, similar to the :mod:`dbm.ndbm` module, but with additional
functionality like crash tolerance.

.. note::

The file formats created by :mod:`dbm.gnu` and :mod:`dbm.ndbm` are incompatible
The file formats created by :mod:`!dbm.gnu` and :mod:`dbm.ndbm` are incompatible
and can not be used interchangeably.

.. include:: ../includes/wasm-mobile-notavail.rst

.. exception:: error

Raised on :mod:`dbm.gnu`-specific errors, such as I/O errors. :exc:`KeyError` is
Raised on :mod:`!dbm.gnu`-specific errors, such as I/O errors. :exc:`KeyError` is
raised for general mapping errors like specifying an incorrect key.


Expand Down Expand Up @@ -343,8 +343,8 @@ functionality like crash tolerance.
unwritten data to be written to the disk.


:mod:`dbm.ndbm` --- New Database Manager
----------------------------------------
:mod:`!dbm.ndbm` --- New Database Manager
-----------------------------------------

.. module:: dbm.ndbm
:platform: Unix
Expand All @@ -354,14 +354,14 @@ functionality like crash tolerance.

--------------

The :mod:`dbm.ndbm` module provides an interface to the
The :mod:`!dbm.ndbm` module provides an interface to the
:abbr:`NDBM (New Database Manager)` library.
This module can be used with the "classic" NDBM interface or the
:abbr:`GDBM (GNU dbm)` compatibility interface.

.. note::

The file formats created by :mod:`dbm.gnu` and :mod:`dbm.ndbm` are incompatible
The file formats created by :mod:`dbm.gnu` and :mod:`!dbm.ndbm` are incompatible
and can not be used interchangeably.

.. warning::
Expand All @@ -375,7 +375,7 @@ This module can be used with the "classic" NDBM interface or the

.. exception:: error

Raised on :mod:`dbm.ndbm`-specific errors, such as I/O errors. :exc:`KeyError` is raised
Raised on :mod:`!dbm.ndbm`-specific errors, such as I/O errors. :exc:`KeyError` is raised
for general mapping errors like specifying an incorrect key.


Expand Down Expand Up @@ -425,8 +425,8 @@ This module can be used with the "classic" NDBM interface or the
Close the NDBM database.


:mod:`dbm.dumb` --- Portable DBM implementation
-----------------------------------------------
:mod:`!dbm.dumb` --- Portable DBM implementation
------------------------------------------------

.. module:: dbm.dumb
:synopsis: Portable implementation of the simple DBM interface.
Expand All @@ -437,14 +437,14 @@ This module can be used with the "classic" NDBM interface or the

.. note::

The :mod:`dbm.dumb` module is intended as a last resort fallback for the
:mod:`!dbm` module when a more robust module is not available. The :mod:`dbm.dumb`
The :mod:`!dbm.dumb` module is intended as a last resort fallback for the
:mod:`!dbm` module when a more robust module is not available. The :mod:`!dbm.dumb`
module is not written for speed and is not nearly as heavily used as the other
database modules.

--------------

The :mod:`dbm.dumb` module provides a persistent :class:`dict`-like
The :mod:`!dbm.dumb` module provides a persistent :class:`dict`-like
interface which is written entirely in Python.
Unlike other :mod:`!dbm` backends, such as :mod:`dbm.gnu`, no
external library is required.
Expand All @@ -453,7 +453,7 @@ The :mod:`!dbm.dumb` module defines the following:

.. exception:: error

Raised on :mod:`dbm.dumb`-specific errors, such as I/O errors. :exc:`KeyError` is
Raised on :mod:`!dbm.dumb`-specific errors, such as I/O errors. :exc:`KeyError` is
raised for general mapping errors like specifying an incorrect key.


Expand Down Expand Up @@ -484,7 +484,7 @@ The :mod:`!dbm.dumb` module defines the following:
Python's AST compiler.

.. warning::
:mod:`dbm.dumb` does not support concurrent read/write access. (Multiple
:mod:`!dbm.dumb` does not support concurrent read/write access. (Multiple
simultaneous read accesses are safe.) When a program has the database open
for writing, no other program should have it open for reading or writing.

Expand Down
18 changes: 9 additions & 9 deletions Doc/library/dialog.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
Tkinter Dialogs
===============

:mod:`tkinter.simpledialog` --- Standard Tkinter input dialogs
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
:mod:`!tkinter.simpledialog` --- Standard Tkinter input dialogs
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. module:: tkinter.simpledialog
:platform: Tk
Expand All @@ -12,7 +12,7 @@ Tkinter Dialogs

--------------

The :mod:`tkinter.simpledialog` module contains convenience classes and
The :mod:`!tkinter.simpledialog` module contains convenience classes and
functions for creating simple modal dialogs to get a value from the user.


Expand All @@ -39,8 +39,8 @@ functions for creating simple modal dialogs to get a value from the user.



:mod:`tkinter.filedialog` --- File selection dialogs
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
:mod:`!tkinter.filedialog` --- File selection dialogs
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. module:: tkinter.filedialog
:platform: Tk
Expand All @@ -50,7 +50,7 @@ functions for creating simple modal dialogs to get a value from the user.

--------------

The :mod:`tkinter.filedialog` module provides classes and factory functions for
The :mod:`!tkinter.filedialog` module provides classes and factory functions for
creating file/directory selection windows.

Native Load/Save Dialogs
Expand Down Expand Up @@ -204,8 +204,8 @@ These do not emulate the native look-and-feel of the platform.
directory. Confirmation is required if an already existing file is
selected.

:mod:`tkinter.commondialog` --- Dialog window templates
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
:mod:`!tkinter.commondialog` --- Dialog window templates
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. module:: tkinter.commondialog
:platform: Tk
Expand All @@ -215,7 +215,7 @@ These do not emulate the native look-and-feel of the platform.

--------------

The :mod:`tkinter.commondialog` module provides the :class:`Dialog` class that
The :mod:`!tkinter.commondialog` module provides the :class:`Dialog` class that
is the base class for dialogs defined in other supporting modules.

.. class:: Dialog(master=None, **options)
Expand Down
2 changes: 1 addition & 1 deletion Doc/library/email.encoders.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ is especially true for :mimetype:`image/\*` and :mimetype:`text/\*` type message
containing binary data.

The :mod:`email` package provides some convenient encoders in its
:mod:`~email.encoders` module. These encoders are actually used by the
:mod:`!encoders` module. These encoders are actually used by the
:class:`~email.mime.audio.MIMEAudio` and :class:`~email.mime.image.MIMEImage`
class constructors to provide default encodings. All encoder functions take
exactly one argument, the message object to encode. They usually extract the
Expand Down
2 changes: 1 addition & 1 deletion Doc/library/email.policy.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -602,7 +602,7 @@ The header objects and their attributes are described in

This concrete :class:`Policy` is the backward compatibility policy. It
replicates the behavior of the email package in Python 3.2. The
:mod:`~email.policy` module also defines an instance of this class,
:mod:`!policy` module also defines an instance of this class,
:const:`compat32`, that is used as the default policy. Thus the default
behavior of the email package is to maintain compatibility with Python 3.2.

Expand Down
14 changes: 7 additions & 7 deletions Doc/library/importlib.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -215,8 +215,8 @@ Functions
in unexpected behavior. It's recommended to use the :class:`threading.Lock`
or other synchronization primitives for thread-safe module reloading.

:mod:`importlib.abc` -- Abstract base classes related to import
---------------------------------------------------------------
:mod:`!importlib.abc` -- Abstract base classes related to import
----------------------------------------------------------------

.. module:: importlib.abc
:synopsis: Abstract base classes related to import
Expand All @@ -226,7 +226,7 @@ Functions
--------------


The :mod:`importlib.abc` module contains all of the core abstract base classes
The :mod:`!importlib.abc` module contains all of the core abstract base classes
used by :keyword:`import`. Some subclasses of the core abstract base classes
are also provided to help in implementing the core ABCs.

Expand Down Expand Up @@ -596,8 +596,8 @@ ABC hierarchy::
itself does not end in ``__init__``.


:mod:`importlib.machinery` -- Importers and path hooks
------------------------------------------------------
:mod:`!importlib.machinery` -- Importers and path hooks
-------------------------------------------------------

.. module:: importlib.machinery
:synopsis: Importers and path hooks
Expand Down Expand Up @@ -1112,8 +1112,8 @@ find and load modules.
Path to the ``.fwork`` file for the extension module.


:mod:`importlib.util` -- Utility code for importers
---------------------------------------------------
:mod:`!importlib.util` -- Utility code for importers
----------------------------------------------------

.. module:: importlib.util
:synopsis: Utility code for importers
Expand Down
2 changes: 1 addition & 1 deletion Doc/library/json.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -748,7 +748,7 @@ Command-line interface
--------------

The :mod:`!json` module can be invoked as a script via ``python -m json``
to validate and pretty-print JSON objects. The :mod:`json.tool` submodule
to validate and pretty-print JSON objects. The :mod:`!json.tool` submodule
implements this interface.

If the optional ``infile`` and ``outfile`` arguments are not
Expand Down
Loading
Loading