Skip to content
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

docs: module page titles should not start with a link to themselves #117099

Merged
merged 1 commit into from
May 8, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 2 additions & 2 deletions Doc/library/__future__.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
:mod:`__future__` --- Future statement definitions
==================================================
:mod:`!__future__` --- Future statement definitions
===================================================

.. module:: __future__
:synopsis: Future statement definitions
Expand Down
4 changes: 2 additions & 2 deletions Doc/library/__main__.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
:mod:`__main__` --- Top-level code environment
==============================================
:mod:`!__main__` --- Top-level code environment
===============================================

.. module:: __main__
:synopsis: The environment where top-level code is run. Covers command-line
Expand Down
4 changes: 2 additions & 2 deletions Doc/library/_thread.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
:mod:`_thread` --- Low-level threading API
==========================================
:mod:`!_thread` --- Low-level threading API
===========================================

.. module:: _thread
:synopsis: Low-level threading API.
Expand Down
4 changes: 2 additions & 2 deletions Doc/library/abc.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
:mod:`abc` --- Abstract Base Classes
====================================
:mod:`!abc` --- Abstract Base Classes
=====================================

.. module:: abc
:synopsis: Abstract base classes according to :pep:`3119`.
Expand Down
4 changes: 2 additions & 2 deletions Doc/library/argparse.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
:mod:`argparse` --- Parser for command-line options, arguments and sub-commands
===============================================================================
:mod:`!argparse` --- Parser for command-line options, arguments and sub-commands
================================================================================

.. module:: argparse
:synopsis: Command-line option and argument parsing library.
Expand Down
4 changes: 2 additions & 2 deletions Doc/library/array.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
:mod:`array` --- Efficient arrays of numeric values
===================================================
:mod:`!array` --- Efficient arrays of numeric values
====================================================

.. module:: array
:synopsis: Space efficient arrays of uniformly typed numeric values.
Expand Down
4 changes: 2 additions & 2 deletions Doc/library/ast.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
:mod:`ast` --- Abstract Syntax Trees
====================================
:mod:`!ast` --- Abstract Syntax Trees
=====================================

.. module:: ast
:synopsis: Abstract Syntax Tree classes and manipulation.
Expand Down
4 changes: 2 additions & 2 deletions Doc/library/asyncio.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
:mod:`asyncio` --- Asynchronous I/O
===================================
:mod:`!asyncio` --- Asynchronous I/O
====================================

.. module:: asyncio
:synopsis: Asynchronous I/O.
Expand Down
4 changes: 2 additions & 2 deletions Doc/library/atexit.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
:mod:`atexit` --- Exit handlers
===============================
:mod:`!atexit` --- Exit handlers
================================

.. module:: atexit
:synopsis: Register and execute cleanup functions.
Expand Down
4 changes: 2 additions & 2 deletions Doc/library/base64.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
:mod:`base64` --- Base16, Base32, Base64, Base85 Data Encodings
===============================================================
:mod:`!base64` --- Base16, Base32, Base64, Base85 Data Encodings
================================================================

.. module:: base64
:synopsis: RFC 4648: Base16, Base32, Base64 Data Encodings;
Expand Down
4 changes: 2 additions & 2 deletions Doc/library/bdb.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
:mod:`bdb` --- Debugger framework
=================================
:mod:`!bdb` --- Debugger framework
==================================

.. module:: bdb
:synopsis: Debugger framework.
Expand Down
4 changes: 2 additions & 2 deletions Doc/library/binascii.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
:mod:`binascii` --- Convert between binary and ASCII
====================================================
:mod:`!binascii` --- Convert between binary and ASCII
=====================================================

.. module:: binascii
:synopsis: Tools for converting between binary and various ASCII-encoded binary
Expand Down
4 changes: 2 additions & 2 deletions Doc/library/bisect.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
:mod:`bisect` --- Array bisection algorithm
===========================================
:mod:`!bisect` --- Array bisection algorithm
============================================

.. module:: bisect
:synopsis: Array bisection algorithms for binary searching.
Expand Down
4 changes: 2 additions & 2 deletions Doc/library/builtins.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
:mod:`builtins` --- Built-in objects
====================================
:mod:`!builtins` --- Built-in objects
=====================================

.. module:: builtins
:synopsis: The module that provides the built-in namespace.
Expand Down
4 changes: 2 additions & 2 deletions Doc/library/bz2.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
:mod:`bz2` --- Support for :program:`bzip2` compression
=======================================================
:mod:`!bz2` --- Support for :program:`bzip2` compression
========================================================

.. module:: bz2
:synopsis: Interfaces for bzip2 compression and decompression.
Expand Down
4 changes: 2 additions & 2 deletions Doc/library/calendar.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
:mod:`calendar` --- General calendar-related functions
======================================================
:mod:`!calendar` --- General calendar-related functions
=======================================================

.. module:: calendar
:synopsis: Functions for working with calendars, including some emulation
Expand Down
4 changes: 2 additions & 2 deletions Doc/library/cmath.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
:mod:`cmath` --- Mathematical functions for complex numbers
===========================================================
:mod:`!cmath` --- Mathematical functions for complex numbers
============================================================

.. module:: cmath
:synopsis: Mathematical functions for complex numbers.
Expand Down
4 changes: 2 additions & 2 deletions Doc/library/cmd.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
:mod:`cmd` --- Support for line-oriented command interpreters
=============================================================
:mod:`!cmd` --- Support for line-oriented command interpreters
==============================================================

.. module:: cmd
:synopsis: Build line-oriented command interpreters.
Expand Down
4 changes: 2 additions & 2 deletions Doc/library/code.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
:mod:`code` --- Interpreter base classes
========================================
:mod:`!code` --- Interpreter base classes
=========================================

.. module:: code
:synopsis: Facilities to implement read-eval-print loops.
Expand Down
4 changes: 2 additions & 2 deletions Doc/library/codecs.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
:mod:`codecs` --- Codec registry and base classes
=================================================
:mod:`!codecs` --- Codec registry and base classes
==================================================

.. module:: codecs
:synopsis: Encode and decode data and streams.
Expand Down
4 changes: 2 additions & 2 deletions Doc/library/codeop.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
:mod:`codeop` --- Compile Python code
=====================================
:mod:`!codeop` --- Compile Python code
======================================

.. module:: codeop
:synopsis: Compile (possibly incomplete) Python code.
Expand Down
4 changes: 2 additions & 2 deletions Doc/library/collections.abc.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
:mod:`collections.abc` --- Abstract Base Classes for Containers
===============================================================
:mod:`!collections.abc` --- Abstract Base Classes for Containers
================================================================

.. module:: collections.abc
:synopsis: Abstract base classes for containers
Expand Down
4 changes: 2 additions & 2 deletions Doc/library/collections.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
:mod:`collections` --- Container datatypes
==========================================
:mod:`!collections` --- Container datatypes
===========================================

.. module:: collections
:synopsis: Container datatypes
Expand Down
4 changes: 2 additions & 2 deletions Doc/library/colorsys.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
:mod:`colorsys` --- Conversions between color systems
=====================================================
:mod:`!colorsys` --- Conversions between color systems
======================================================

.. module:: colorsys
:synopsis: Conversion functions between RGB and other color systems.
Expand Down
4 changes: 2 additions & 2 deletions Doc/library/compileall.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
:mod:`compileall` --- Byte-compile Python libraries
===================================================
:mod:`!compileall` --- Byte-compile Python libraries
====================================================

.. module:: compileall
:synopsis: Tools for byte-compiling all Python source files in a directory tree.
Expand Down
4 changes: 2 additions & 2 deletions Doc/library/concurrent.futures.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
:mod:`concurrent.futures` --- Launching parallel tasks
======================================================
:mod:`!concurrent.futures` --- Launching parallel tasks
=======================================================

.. module:: concurrent.futures
:synopsis: Execute computations concurrently using threads or processes.
Expand Down
4 changes: 2 additions & 2 deletions Doc/library/configparser.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
:mod:`configparser` --- Configuration file parser
=================================================
:mod:`!configparser` --- Configuration file parser
==================================================

.. module:: configparser
:synopsis: Configuration file parser.
Expand Down
4 changes: 2 additions & 2 deletions Doc/library/contextvars.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
:mod:`contextvars` --- Context Variables
========================================
:mod:`!contextvars` --- Context Variables
=========================================

.. module:: contextvars
:synopsis: Context Variables
Expand Down
4 changes: 2 additions & 2 deletions Doc/library/copy.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
:mod:`copy` --- Shallow and deep copy operations
================================================
:mod:`!copy` --- Shallow and deep copy operations
=================================================

.. module:: copy
:synopsis: Shallow and deep copy operations.
Expand Down
4 changes: 2 additions & 2 deletions Doc/library/copyreg.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
:mod:`copyreg` --- Register :mod:`pickle` support functions
===========================================================
:mod:`!copyreg` --- Register :mod:`!pickle` support functions
=============================================================

.. module:: copyreg
:synopsis: Register pickle support functions.
Expand Down
4 changes: 2 additions & 2 deletions Doc/library/csv.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
:mod:`csv` --- CSV File Reading and Writing
===========================================
:mod:`!csv` --- CSV File Reading and Writing
============================================

.. module:: csv
:synopsis: Write and read tabular data to and from delimited files.
Expand Down
4 changes: 2 additions & 2 deletions Doc/library/ctypes.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
:mod:`ctypes` --- A foreign function library for Python
=======================================================
:mod:`!ctypes` --- A foreign function library for Python
========================================================

.. module:: ctypes
:synopsis: A foreign function library for Python.
Expand Down
4 changes: 2 additions & 2 deletions Doc/library/curses.ascii.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
:mod:`curses.ascii` --- Utilities for ASCII characters
======================================================
:mod:`!curses.ascii` --- Utilities for ASCII characters
=======================================================

.. module:: curses.ascii
:synopsis: Constants and set-membership functions for ASCII characters.
Expand Down
4 changes: 2 additions & 2 deletions Doc/library/curses.panel.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
:mod:`curses.panel` --- A panel stack extension for curses
==========================================================
:mod:`!curses.panel` --- A panel stack extension for curses
===========================================================

.. module:: curses.panel
:synopsis: A panel stack extension that adds depth to curses windows.
Expand Down
4 changes: 2 additions & 2 deletions Doc/library/curses.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
:mod:`curses` --- Terminal handling for character-cell displays
===============================================================
:mod:`!curses` --- Terminal handling for character-cell displays
================================================================

.. module:: curses
:synopsis: An interface to the curses library, providing portable
Expand Down
4 changes: 2 additions & 2 deletions Doc/library/dataclasses.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
:mod:`dataclasses` --- Data Classes
===================================
:mod:`!dataclasses` --- Data Classes
====================================

.. module:: dataclasses
:synopsis: Generate special methods on user-defined classes.
Expand Down
4 changes: 2 additions & 2 deletions Doc/library/datetime.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
:mod:`datetime` --- Basic date and time types
=============================================
:mod:`!datetime` --- Basic date and time types
==============================================

.. module:: datetime
:synopsis: Basic date and time types.
Expand Down
4 changes: 2 additions & 2 deletions Doc/library/dbm.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
:mod:`dbm` --- Interfaces to Unix "databases"
=============================================
:mod:`!dbm` --- Interfaces to Unix "databases"
==============================================

.. module:: dbm
:synopsis: Interfaces to various Unix "database" formats.
Expand Down
4 changes: 2 additions & 2 deletions Doc/library/decimal.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
:mod:`decimal` --- Decimal fixed point and floating point arithmetic
====================================================================
:mod:`!decimal` --- Decimal fixed point and floating point arithmetic
=====================================================================

.. module:: decimal
:synopsis: Implementation of the General Decimal Arithmetic Specification.
Expand Down
4 changes: 2 additions & 2 deletions Doc/library/difflib.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
:mod:`difflib` --- Helpers for computing deltas
===============================================
:mod:`!difflib` --- Helpers for computing deltas
================================================

.. module:: difflib
:synopsis: Helpers for computing differences between objects.
Expand Down
4 changes: 2 additions & 2 deletions Doc/library/dis.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
:mod:`dis` --- Disassembler for Python bytecode
===============================================
:mod:`!dis` --- Disassembler for Python bytecode
================================================

.. module:: dis
:synopsis: Disassembler for Python bytecode.
Expand Down
4 changes: 2 additions & 2 deletions Doc/library/doctest.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
:mod:`doctest` --- Test interactive Python examples
===================================================
:mod:`!doctest` --- Test interactive Python examples
====================================================

.. module:: doctest
:synopsis: Test pieces of code within docstrings.
Expand Down
4 changes: 2 additions & 2 deletions Doc/library/email.charset.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
:mod:`email.charset`: Representing character sets
-------------------------------------------------
:mod:`!email.charset`: Representing character sets
--------------------------------------------------

.. module:: email.charset
:synopsis: Character Sets
Expand Down
4 changes: 2 additions & 2 deletions Doc/library/email.contentmanager.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
:mod:`email.contentmanager`: Managing MIME Content
--------------------------------------------------
:mod:`!email.contentmanager`: Managing MIME Content
---------------------------------------------------

.. module:: email.contentmanager
:synopsis: Storing and Retrieving Content from MIME Parts
Expand Down
4 changes: 2 additions & 2 deletions Doc/library/email.encoders.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
:mod:`email.encoders`: Encoders
-------------------------------
:mod:`!email.encoders`: Encoders
--------------------------------

.. module:: email.encoders
:synopsis: Encoders for email message payloads.
Expand Down
4 changes: 2 additions & 2 deletions Doc/library/email.errors.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
:mod:`email.errors`: Exception and Defect classes
-------------------------------------------------
:mod:`!email.errors`: Exception and Defect classes
--------------------------------------------------

.. module:: email.errors
:synopsis: The exception classes used by the email package.
Expand Down
4 changes: 2 additions & 2 deletions Doc/library/email.generator.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
:mod:`email.generator`: Generating MIME documents
-------------------------------------------------
:mod:`!email.generator`: Generating MIME documents
--------------------------------------------------

.. module:: email.generator
:synopsis: Generate flat text email messages from a message structure.
Expand Down
4 changes: 2 additions & 2 deletions Doc/library/email.header.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
:mod:`email.header`: Internationalized headers
----------------------------------------------
:mod:`!email.header`: Internationalized headers
-----------------------------------------------

.. module:: email.header
:synopsis: Representing non-ASCII headers
Expand Down
4 changes: 2 additions & 2 deletions Doc/library/email.headerregistry.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
:mod:`email.headerregistry`: Custom Header Objects
--------------------------------------------------
:mod:`!email.headerregistry`: Custom Header Objects
---------------------------------------------------

.. module:: email.headerregistry
:synopsis: Automatic Parsing of headers based on the field name
Expand Down
4 changes: 2 additions & 2 deletions Doc/library/email.iterators.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
:mod:`email.iterators`: Iterators
---------------------------------
:mod:`!email.iterators`: Iterators
----------------------------------

.. module:: email.iterators
:synopsis: Iterate over a message object tree.
Expand Down
Loading
Loading