Closes python#4159: add LaTeX tabular column specifications to tables that otherwise are cut off or have overlapping text.

birkenfeld · birkenfeld · commit 44ea77bd817c · 2013-03-28T13:28:44.000+01:00
diff --git a/Doc/c-api/buffer.rst b/Doc/c-api/buffer.rst
@@ -263,6 +263,7 @@ The flags that control the logical structure of the memory are listed
 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 @@ contiguity requests
 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 @@ used combinations as single flags.
 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
@@ -62,6 +62,8 @@ called with a non-bytes parameter.
    .. % 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
@@ -439,6 +439,8 @@ APIs:
    .. % 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
@@ -26,6 +26,8 @@ setup script). Indirectly provides the  :class:`distutils.dist.Distribution` and
    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 @@ setup script). Indirectly provides the  :class:`distutils.dist.Distribution` and
 
    *stop_after* tells :func:`setup` when to stop processing; possible  values:
 
+   .. tabularcolumns:: |l|L|
+
    +---------------+---------------------------------------------+
    | value         | description                                 |
    +===============+=============================================+
@@ -165,6 +169,8 @@ the full reference.
    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 @@ lines, and joining lines with backslashes.
 
    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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -4,7 +4,9 @@
 Programming FAQ
 ===============
 
-.. contents::
+.. only:: html
+
+   .. contents::
 
 General Questions
 =================
diff --git 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
@@ -63,6 +63,8 @@ The logging functions are named after the level or severity of the events
 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
@@ -235,6 +235,8 @@ by how you built/installed Python itself.  On Unix (and Mac OS X, which is also
 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
@@ -315,6 +315,8 @@ To simplify and standardize error handling, the :meth:`encode` and
 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 @@ particular, the following variants typically exist:
 
 * 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 @@ particular, the following variants typically exist:
 
 .. 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 @@ particular, the following variants typically exist:
 
 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 bytes-to-bytes mappings.
 
 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
@@ -31,6 +31,8 @@ Collections Abstract Base Classes
 
 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 @@ classes supporting container APIs.  For example, to write a class supporting
 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
@@ -346,6 +346,8 @@ Module Functions
    *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
@@ -139,6 +139,8 @@ added matters.  To illustrate::
       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
@@ -843,7 +843,7 @@ are always available.  They are listed here in alphabetical order.
 
    ========= ===============================================================
    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
@@ -520,6 +520,8 @@ function.
       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
@@ -187,6 +187,8 @@ Argument names are not part of the specification, and only the arguments of
 
 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
@@ -55,6 +55,8 @@ The :mod:`locale` module defines the following exception and functions:
    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
@@ -1037,6 +1037,8 @@ functions.
 
    The following keyword arguments are supported.
 
+   .. tabularcolumns:: |l|L|
+
    +--------------+---------------------------------------------+
    | Format       | Description                                 |
    +==============+=============================================+
diff --git a/Doc/library/subprocess.rst b/Doc/library/subprocess.rst
@@ -169,6 +169,8 @@ use cases, the underlying :class:`Popen` interface can be used directly.
 
    .. 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
@@ -307,6 +307,8 @@ always available.
    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 @@ always available.
    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 @@ always available.
    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
diff --git a/Doc/library/turtle.rst b/Doc/library/turtle.rst
diff --git a/Doc/library/warnings.rst b/Doc/library/warnings.rst
diff --git a/Doc/library/xml.etree.elementtree.rst b/Doc/library/xml.etree.elementtree.rst
diff --git a/Doc/library/xmlrpc.client.rst b/Doc/library/xmlrpc.client.rst
diff --git a/Doc/reference/datamodel.rst b/Doc/reference/datamodel.rst
diff --git a/Doc/reference/expressions.rst b/Doc/reference/expressions.rst
diff --git a/Doc/reference/import.rst b/Doc/reference/import.rst
diff --git a/Doc/whatsnew/3.3.rst b/Doc/whatsnew/3.3.rst
