Closes #4159: add LaTeX tabular column specifications to tables that otherwise are cut off or have overlapping text.
diff --git a/Doc/c-api/buffer.rst b/Doc/c-api/buffer.rst
index 0b521df..f703e9c 100644
--- a/Doc/c-api/buffer.rst
+++ b/Doc/c-api/buffer.rst
@@ -263,6 +263,7 @@
in decreasing order of complexity. Note that each flag contains all bits
of the flags below it.
+.. tabularcolumns:: |p{0.35\linewidth}|l|l|l|
+-----------------------------+-------+---------+------------+
| Request | shape | strides | suboffsets |
@@ -283,6 +284,8 @@
C or Fortran contiguity can be explicitly requested, with and without stride
information. Without stride information, the buffer must be C-contiguous.
+.. tabularcolumns:: |p{0.35\linewidth}|l|l|l|l|
+
+-----------------------------------+-------+---------+------------+--------+
| Request | shape | strides | suboffsets | contig |
+===================================+=======+=========+============+========+
@@ -306,7 +309,7 @@
In the following table *U* stands for undefined contiguity. The consumer would
have to call :c:func:`PyBuffer_IsContiguous` to determine contiguity.
-
+.. tabularcolumns:: |p{0.35\linewidth}|l|l|l|l|l|l|
+-------------------------------+-------+---------+------------+--------+----------+--------+
| Request | shape | strides | suboffsets | contig | readonly | format |
diff --git a/Doc/c-api/bytes.rst b/Doc/c-api/bytes.rst
index 12ec80c..5666dac 100644
--- a/Doc/c-api/bytes.rst
+++ b/Doc/c-api/bytes.rst
@@ -62,6 +62,8 @@
.. % because not all compilers support the %z width modifier -- we fake it
.. % when necessary via interpolating PY_FORMAT_SIZE_T.
+ .. tabularcolumns:: |l|l|L|
+
+-------------------+---------------+--------------------------------+
| Format Characters | Type | Comment |
+===================+===============+================================+
diff --git a/Doc/c-api/unicode.rst b/Doc/c-api/unicode.rst
index 89bd148..abf353f 100644
--- a/Doc/c-api/unicode.rst
+++ b/Doc/c-api/unicode.rst
@@ -439,6 +439,8 @@
.. % Similar comments apply to the %ll width modifier and
.. % PY_FORMAT_LONG_LONG.
+ .. tabularcolumns:: |l|l|L|
+
+-------------------+---------------------+--------------------------------+
| Format Characters | Type | Comment |
+===================+=====================+================================+
diff --git a/Doc/distutils/apiref.rst b/Doc/distutils/apiref.rst
index 1381afc..c323775 100644
--- a/Doc/distutils/apiref.rst
+++ b/Doc/distutils/apiref.rst
@@ -26,6 +26,8 @@
The setup function takes a large number of arguments. These are laid out in the
following table.
+ .. tabularcolumns:: |l|L|L|
+
+--------------------+--------------------------------+-------------------------------------------------------------+
| argument name | value | type |
+====================+================================+=============================================================+
@@ -125,6 +127,8 @@
*stop_after* tells :func:`setup` when to stop processing; possible values:
+ .. tabularcolumns:: |l|L|
+
+---------------+---------------------------------------------+
| value | description |
+===============+=============================================+
@@ -165,6 +169,8 @@
The Extension class describes a single C or C++extension module in a setup
script. It accepts the following keyword arguments in its constructor:
+ .. tabularcolumns:: |l|L|l|
+
+------------------------+--------------------------------+---------------------------+
| argument name | value | type |
+========================+================================+===========================+
@@ -1562,6 +1568,8 @@
The options are all boolean, and affect the values returned by :meth:`readline`
+ .. tabularcolumns:: |l|L|l|
+
+------------------+--------------------------------+---------+
| option name | description | default |
+==================+================================+=========+
diff --git a/Doc/faq/extending.rst b/Doc/faq/extending.rst
index 4afb510..a9a234b 100644
--- a/Doc/faq/extending.rst
+++ b/Doc/faq/extending.rst
@@ -2,7 +2,9 @@
Extending/Embedding FAQ
=======================
-.. contents::
+.. only:: html
+
+ .. contents::
.. highlight:: c
diff --git a/Doc/faq/general.rst b/Doc/faq/general.rst
index 9f26dc9..9a893ec 100644
--- a/Doc/faq/general.rst
+++ b/Doc/faq/general.rst
@@ -4,7 +4,10 @@
General Python FAQ
==================
-.. contents::
+.. only:: html
+
+ .. contents::
+
General Information
===================
diff --git a/Doc/faq/gui.rst b/Doc/faq/gui.rst
index f697cd3..5827f28 100644
--- a/Doc/faq/gui.rst
+++ b/Doc/faq/gui.rst
@@ -4,7 +4,9 @@
Graphic User Interface FAQ
==========================
-.. contents::
+.. only:: html
+
+ .. contents::
.. XXX need review for Python 3.
diff --git a/Doc/faq/library.rst b/Doc/faq/library.rst
index cab2d7b..c8ef9e7 100644
--- a/Doc/faq/library.rst
+++ b/Doc/faq/library.rst
@@ -4,7 +4,9 @@
Library and Extension FAQ
=========================
-.. contents::
+.. only:: html
+
+ .. contents::
General Library Questions
=========================
diff --git a/Doc/faq/programming.rst b/Doc/faq/programming.rst
index 32123de..0f4d148 100644
--- a/Doc/faq/programming.rst
+++ b/Doc/faq/programming.rst
@@ -4,7 +4,9 @@
Programming FAQ
===============
-.. contents::
+.. only:: html
+
+ .. contents::
General Questions
=================
diff --git a/Doc/faq/windows.rst b/Doc/faq/windows.rst
index 0a85a40..651ba22 100644
--- a/Doc/faq/windows.rst
+++ b/Doc/faq/windows.rst
@@ -6,7 +6,9 @@
Python on Windows FAQ
=====================
-.. contents::
+.. only:: html
+
+ .. contents::
.. XXX need review for Python 3.
XXX need review for Windows Vista/Seven?
diff --git a/Doc/howto/logging.rst b/Doc/howto/logging.rst
index 79f1336..aa40446 100644
--- a/Doc/howto/logging.rst
+++ b/Doc/howto/logging.rst
@@ -63,6 +63,8 @@
they are used to track. The standard levels and their applicability are
described below (in increasing order of severity):
+.. tabularcolumns:: |l|L|
+
+--------------+---------------------------------------------+
| Level | When it's used |
+==============+=============================================+
diff --git a/Doc/install/index.rst b/Doc/install/index.rst
index c31b198..e0c5c16 100644
--- a/Doc/install/index.rst
+++ b/Doc/install/index.rst
@@ -235,6 +235,8 @@
Unix-based), it also depends on whether the module distribution being installed
is pure Python or contains extensions ("non-pure"):
+.. tabularcolumns:: |l|l|l|l|
+
+-----------------+-----------------------------------------------------+--------------------------------------------------+-------+
| Platform | Standard installation location | Default value | Notes |
+=================+=====================================================+==================================================+=======+
diff --git a/Doc/library/codecs.rst b/Doc/library/codecs.rst
index 28ea89d..9e1a9c7 100644
--- a/Doc/library/codecs.rst
+++ b/Doc/library/codecs.rst
@@ -315,6 +315,8 @@
providing the *errors* string argument. The following string values are defined
and implemented by all standard Python codecs:
+.. tabularcolumns:: |l|L|
+
+-------------------------+-----------------------------------------------+
| Value | Meaning |
+=========================+===============================================+
@@ -926,6 +928,8 @@
* an IBM PC code page, which is ASCII compatible
+.. tabularcolumns:: |l|p{0.3\linewidth}|p{0.3\linewidth}|
+
+-----------------+--------------------------------+--------------------------------+
| Codec | Aliases | Languages |
+=================+================================+================================+
@@ -1140,6 +1144,8 @@
.. XXX fix here, should be in above table
+.. tabularcolumns:: |l|p{0.3\linewidth}|p{0.3\linewidth}|
+
+--------------------+---------+---------------------------+
| Codec | Aliases | Purpose |
+====================+=========+===========================+
@@ -1182,6 +1188,8 @@
The following codecs provide bytes-to-bytes mappings.
+.. tabularcolumns:: |l|p{0.3\linewidth}|p{0.3\linewidth}|
+
+--------------------+---------------------------+---------------------------+
| Codec | Aliases | Purpose |
+====================+===========================+===========================+
@@ -1208,6 +1216,8 @@
The following codecs provide string-to-string mappings.
+.. tabularcolumns:: |l|p{0.3\linewidth}|p{0.3\linewidth}|
+
+--------------------+---------------------------+---------------------------+
| Codec | Aliases | Purpose |
+====================+===========================+===========================+
diff --git a/Doc/library/collections.abc.rst b/Doc/library/collections.abc.rst
index 5eea0df..115ce10 100644
--- a/Doc/library/collections.abc.rst
+++ b/Doc/library/collections.abc.rst
@@ -31,6 +31,8 @@
The collections module offers the following :term:`ABCs <abstract base class>`:
+.. tabularcolumns:: |l|L|L|L|
+
========================= ===================== ====================== ====================================================
ABC Inherits from Abstract Methods Mixin Methods
========================= ===================== ====================== ====================================================
@@ -134,7 +136,7 @@
the full :class:`Set` API, it only necessary to supply the three underlying
abstract methods: :meth:`__contains__`, :meth:`__iter__`, and :meth:`__len__`.
The ABC supplies the remaining methods such as :meth:`__and__` and
-:meth:`isdisjoint` ::
+:meth:`isdisjoint`::
class ListBasedSet(collections.Set):
''' Alternate set implementation favoring space over speed
diff --git a/Doc/library/concurrent.futures.rst b/Doc/library/concurrent.futures.rst
index 7ed99d5..51584ef 100644
--- a/Doc/library/concurrent.futures.rst
+++ b/Doc/library/concurrent.futures.rst
@@ -346,6 +346,8 @@
*return_when* indicates when this function should return. It must be one of
the following constants:
+ .. tabularcolumns:: |l|L|
+
+-----------------------------+----------------------------------------+
| Constant | Description |
+=============================+========================================+
diff --git a/Doc/library/email.policy.rst b/Doc/library/email.policy.rst
index 51ac5c0..06d9821 100644
--- a/Doc/library/email.policy.rst
+++ b/Doc/library/email.policy.rst
@@ -139,6 +139,8 @@
Controls the type of Content Transfer Encodings that may be or are
required to be used. The possible values are:
+ .. tabularcolumns:: |l|L|
+
======== ===============================================================
``7bit`` all data must be "7 bit clean" (ASCII-only). This means that
where necessary data will be encoded using either
diff --git a/Doc/library/functions.rst b/Doc/library/functions.rst
index 91d0aaf..c82e03f 100644
--- a/Doc/library/functions.rst
+++ b/Doc/library/functions.rst
@@ -843,7 +843,7 @@
========= ===============================================================
Character Meaning
- --------- ---------------------------------------------------------------
+ ========= ===============================================================
``'r'`` open for reading (default)
``'w'`` open for writing, truncating the file first
``'x'`` open for exclusive creation, failing if the file already exists
diff --git a/Doc/library/inspect.rst b/Doc/library/inspect.rst
index 01bbce8..40f482b 100644
--- a/Doc/library/inspect.rst
+++ b/Doc/library/inspect.rst
@@ -520,6 +520,8 @@
Describes how argument values are bound to the parameter. Possible values
(accessible via :class:`Parameter`, like ``Parameter.KEYWORD_ONLY``):
+ .. tabularcolumns:: |l|L|
+
+------------------------+----------------------------------------------+
| Name | Meaning |
+========================+==============================================+
diff --git a/Doc/library/io.rst b/Doc/library/io.rst
index d30c5fd..a8d5fe3 100644
--- a/Doc/library/io.rst
+++ b/Doc/library/io.rst
@@ -187,6 +187,8 @@
The following table summarizes the ABCs provided by the :mod:`io` module:
+.. tabularcolumns:: |l|l|L|L|
+
========================= ================== ======================== ==================================================
ABC Inherits Stub Methods Mixin Methods and Properties
========================= ================== ======================== ==================================================
diff --git a/Doc/library/locale.rst b/Doc/library/locale.rst
index d46f1cf..9600193 100644
--- a/Doc/library/locale.rst
+++ b/Doc/library/locale.rst
@@ -55,6 +55,8 @@
Returns the database of the local conventions as a dictionary. This dictionary
has the following strings as keys:
+ .. tabularcolumns:: |l|l|L|
+
+----------------------+-------------------------------------+--------------------------------+
| Category | Key | Meaning |
+======================+=====================================+================================+
diff --git a/Doc/library/logging.rst b/Doc/library/logging.rst
index 11863a9..8203733 100644
--- a/Doc/library/logging.rst
+++ b/Doc/library/logging.rst
@@ -1037,6 +1037,8 @@
The following keyword arguments are supported.
+ .. tabularcolumns:: |l|L|
+
+--------------+---------------------------------------------+
| Format | Description |
+==============+=============================================+
diff --git a/Doc/library/subprocess.rst b/Doc/library/subprocess.rst
index a72ca44..4212e02 100644
--- a/Doc/library/subprocess.rst
+++ b/Doc/library/subprocess.rst
@@ -169,6 +169,8 @@
.. versionadded:: 3.1
+ ..
+
.. warning::
Invoking the system shell with ``shell=True`` can be a security hazard
diff --git a/Doc/library/sys.rst b/Doc/library/sys.rst
index 7745559..e7e853d 100644
--- a/Doc/library/sys.rst
+++ b/Doc/library/sys.rst
@@ -307,6 +307,8 @@
programming language; see section 5.2.4.2.2 of the 1999 ISO/IEC C standard
[C99]_, 'Characteristics of floating types', for details.
+ .. tabularcolumns:: |l|l|L|
+
+---------------------+----------------+--------------------------------------------------+
| attribute | float.h macro | explanation |
+=====================+================+==================================================+
@@ -646,6 +648,8 @@
A :term:`struct sequence` that holds information about Python's internal
representation of integers. The attributes are read only.
+ .. tabularcolumns:: |l|L|
+
+-------------------------+----------------------------------------------+
| Attribute | Explanation |
+=========================+==============================================+
@@ -1079,6 +1083,8 @@
A :term:`struct sequence` holding information about the thread
implementation.
+ .. tabularcolumns:: |l|p{0.7\linewidth}|
+
+------------------+---------------------------------------------------------+
| Attribute | Explanation |
+==================+=========================================================+
diff --git a/Doc/library/tkinter.ttk.rst b/Doc/library/tkinter.ttk.rst
index ed351f5..9860c86 100644
--- a/Doc/library/tkinter.ttk.rst
+++ b/Doc/library/tkinter.ttk.rst
@@ -102,6 +102,8 @@
All the :mod:`ttk` Widgets accepts the following options:
+ .. tabularcolumns:: |l|L|
+
+-----------+--------------------------------------------------------------+
| Option | Description |
+===========+==============================================================+
@@ -134,8 +136,10 @@
The following options are supported by widgets that are controlled by a
scrollbar.
+ .. tabularcolumns:: |l|L|
+
+----------------+---------------------------------------------------------+
- | option | description |
+ | Option | Description |
+================+=========================================================+
| xscrollcommand | Used to communicate with horizontal scrollbars. |
| | |
@@ -158,11 +162,10 @@
The following options are supported by labels, buttons and other button-like
widgets.
-.. tabularcolumns:: |p{0.2\textwidth}|p{0.7\textwidth}|
-..
+ .. tabularcolumns:: |l|p{0.7\linewidth}|
+--------------+-----------------------------------------------------------+
- | option | description |
+ | Option | Description |
+==============+===========================================================+
| text | Specifies a text string to be displayed inside the widget.|
+--------------+-----------------------------------------------------------+
@@ -202,8 +205,10 @@
Compatibility Options
^^^^^^^^^^^^^^^^^^^^^
+ .. tabularcolumns:: |l|L|
+
+--------+----------------------------------------------------------------+
- | option | description |
+ | Option | Description |
+========+================================================================+
| state | May be set to "normal" or "disabled" to control the "disabled" |
| | state bit. This is a write-only option: setting it changes the |
@@ -216,8 +221,10 @@
The widget state is a bitmap of independent state flags.
+ .. tabularcolumns:: |l|L|
+
+------------+-------------------------------------------------------------+
- | flag | description |
+ | Flag | Description |
+============+=============================================================+
| active | The mouse cursor is over the widget and pressing a mouse |
| | button will cause some action to occur |
@@ -301,8 +308,10 @@
This widget accepts the following specific options:
+ .. tabularcolumns:: |l|L|
+
+-----------------+--------------------------------------------------------+
- | option | description |
+ | Option | Description |
+=================+========================================================+
| exportselection | Boolean value. If set, the widget selection is linked |
| | to the Window Manager selection (which can be returned |
@@ -380,8 +389,10 @@
This widget accepts the following specific options:
+ .. tabularcolumns:: |l|L|
+
+---------+----------------------------------------------------------------+
- | option | description |
+ | Option | Description |
+=========+================================================================+
| height | If present and greater than zero, specifies the desired height |
| | of the pane area (not including internal padding or tabs). |
@@ -404,8 +415,10 @@
There are also specific options for tabs:
+ .. tabularcolumns:: |l|L|
+
+-----------+--------------------------------------------------------------+
- | option | description |
+ | Option | Description |
+===========+==============================================================+
| state | Either "normal", "disabled" or "hidden". If "disabled", then |
| | the tab is not selectable. If "hidden", then the tab is not |
@@ -566,8 +579,10 @@
This widget accepts the following specific options:
+ .. tabularcolumns:: |l|L|
+
+----------+---------------------------------------------------------------+
- | option | description |
+ | Option | Description |
+==========+===============================================================+
| orient | One of "horizontal" or "vertical". Specifies the orientation |
| | of the progress bar. |
@@ -635,8 +650,10 @@
This widget accepts the following specific option:
+ .. tabularcolumns:: |l|L|
+
+--------+----------------------------------------------------------------+
- | option | description |
+ | Option | Description |
+========+================================================================+
| orient | One of "horizontal" or "vertical". Specifies the orientation of|
| | the separator. |
@@ -701,11 +718,10 @@
This widget accepts the following specific options:
-.. tabularcolumns:: |p{0.2\textwidth}|p{0.7\textwidth}|
-..
+ .. tabularcolumns:: |l|p{0.7\linewidth}|
+----------------+--------------------------------------------------------+
- | option | description |
+ | Option | Description |
+================+========================================================+
| columns | A list of column identifiers, specifying the number of |
| | columns and their names. |
@@ -753,8 +769,10 @@
The following item options may be specified for items in the insert and item
widget commands.
+ .. tabularcolumns:: |l|L|
+
+--------+---------------------------------------------------------------+
- | option | description |
+ | Option | Description |
+========+===============================================================+
| text | The textual label to display for the item. |
+--------+---------------------------------------------------------------+
@@ -779,8 +797,10 @@
The following options may be specified on tags:
+ .. tabularcolumns:: |l|L|
+
+------------+-----------------------------------------------------------+
- | option | description |
+ | Option | Description |
+============+===========================================================+
| foreground | Specifies the text foreground color. |
+------------+-----------------------------------------------------------+
@@ -822,8 +842,10 @@
The Treeview widget generates the following virtual events.
+ .. tabularcolumns:: |l|L|
+
+--------------------+--------------------------------------------------+
- | event | description |
+ | Event | Description |
+====================+==================================================+
| <<TreeviewSelect>> | Generated whenever the selection changes. |
+--------------------+--------------------------------------------------+
diff --git a/Doc/library/turtle.rst b/Doc/library/turtle.rst
index 4373f78..aea9450 100644
--- a/Doc/library/turtle.rst
+++ b/Doc/library/turtle.rst
@@ -2301,9 +2301,11 @@
The demo scripts are:
+.. tabularcolumns:: |l|L|L|
+
+----------------+------------------------------+-----------------------+
| Name | Description | Features |
-+----------------+------------------------------+-----------------------+
++================+==============================+=======================+
| bytedesign | complex classical | :func:`tracer`, delay,|
| | turtle graphics pattern | :func:`update` |
+----------------+------------------------------+-----------------------+
diff --git a/Doc/library/warnings.rst b/Doc/library/warnings.rst
index 8387f5a..ce69f7b 100644
--- a/Doc/library/warnings.rst
+++ b/Doc/library/warnings.rst
@@ -54,6 +54,8 @@
This categorization is useful to be able to filter out groups of warnings. The
following warnings category classes are currently defined:
+.. tabularcolumns:: |l|p{0.6\linewidth}|
+
+----------------------------------+-----------------------------------------------+
| Class | Description |
+==================================+===============================================+
diff --git a/Doc/library/xml.etree.elementtree.rst b/Doc/library/xml.etree.elementtree.rst
index e429f04..45a0e7b 100644
--- a/Doc/library/xml.etree.elementtree.rst
+++ b/Doc/library/xml.etree.elementtree.rst
@@ -278,6 +278,8 @@
Supported XPath syntax
^^^^^^^^^^^^^^^^^^^^^^
+.. tabularcolumns:: |l|L|
+
+-----------------------+------------------------------------------------------+
| Syntax | Meaning |
+=======================+======================================================+
diff --git a/Doc/library/xmlrpc.client.rst b/Doc/library/xmlrpc.client.rst
index 3a53655..bc4d4aa 100644
--- a/Doc/library/xmlrpc.client.rst
+++ b/Doc/library/xmlrpc.client.rst
@@ -72,6 +72,8 @@
(e.g. that can be marshalled through XML), include the following (and except
where noted, they are unmarshalled as the same Python type):
+ .. tabularcolumns:: |l|L|
+
+---------------------------------+---------------------------------------------+
| Name | Meaning |
+=================================+=============================================+
diff --git a/Doc/reference/datamodel.rst b/Doc/reference/datamodel.rst
index 7c51068..e815690 100644
--- a/Doc/reference/datamodel.rst
+++ b/Doc/reference/datamodel.rst
@@ -448,6 +448,8 @@
Special attributes:
+ .. tabularcolumns:: |l|L|l|
+
+-------------------------+-------------------------------+-----------+
| Attribute | Meaning | |
+=========================+===============================+===========+
diff --git a/Doc/reference/expressions.rst b/Doc/reference/expressions.rst
index f88709e..c866f84 100644
--- a/Doc/reference/expressions.rst
+++ b/Doc/reference/expressions.rst
@@ -1335,7 +1335,7 @@
| :keyword:`not` ``x`` | Boolean NOT |
+-----------------------------------------------+-------------------------------------+
| :keyword:`in`, :keyword:`not in`, | Comparisons, including membership |
-| :keyword:`is`, :keyword:`is not`, ``<``, | tests and identity tests, |
+| :keyword:`is`, :keyword:`is not`, ``<``, | tests and identity tests |
| ``<=``, ``>``, ``>=``, ``!=``, ``==`` | |
+-----------------------------------------------+-------------------------------------+
| ``|`` | Bitwise OR |
diff --git a/Doc/reference/import.rst b/Doc/reference/import.rst
index ef0235d..5874606 100644
--- a/Doc/reference/import.rst
+++ b/Doc/reference/import.rst
@@ -685,8 +685,7 @@
:pep:`338` defines executing modules as scripts.
-Footnotes
-=========
+.. rubric:: Footnotes
.. [#fnmo] See :class:`types.ModuleType`.
diff --git a/Doc/whatsnew/3.3.rst b/Doc/whatsnew/3.3.rst
index 4ea4995..6188335 100644
--- a/Doc/whatsnew/3.3.rst
+++ b/Doc/whatsnew/3.3.rst
@@ -1208,6 +1208,8 @@
The minimum set of controls implemented by all ``policy`` objects are:
+ .. tabularcolumns:: |l|L|
+
=============== =======================================================
max_line_length The maximum length, excluding the linesep character(s),
individual lines may have when a ``Message`` is
@@ -1259,6 +1261,8 @@
The new policies are instances of :class:`~email.policy.EmailPolicy`,
and add the following additional controls:
+ .. tabularcolumns:: |l|L|
+
=============== =======================================================
refold_source Controls whether or not headers parsed by a
:mod:`~email.parser` are refolded by the