Document 2to3 features.

--HG--
branch : distribute
extra : rebase_source : 83d21c2b058553bf4c1cadf7aaa71bcf34ebfcdd

1 files changed, 24 insertions, 0 deletions

diff --git a/docs/setuptools.txt b/docs/setuptools.txt
index 7de0ab08..1c73d4a9 100644
--- a/docs/setuptools.txt
+++ b/docs/setuptools.txt
@@ -404,6 +404,10 @@ unless you need the associated ``setuptools`` feature.
     mess with it.  For more details on how this argument works, see the section
     below on `Automatic Resource Extraction`_.
 
+``convert_doctests_2to3``
+    List of doctest source files that need to be converted with 2to3. See
+    `Converting with 2to3`_ below for more details.
+
 
 Using ``find_packages()``
 -------------------------
@@ -446,6 +450,26 @@ argument in your setup script.  Especially since it frees you from having to
 remember to modify your setup script whenever your project grows additional
 top-level packages or subpackages.
 
+Converting with 2to3
+--------------------
+
+When run under Python 3.x, setuptools will automatically run 2to3 on
+all Python source files, if ``setuptools.run_2to3`` is set to True; by
+default, this variable is False. It will also convert doctests inside
+all Python source files, unless ``setuptools.run_2to3_on_doctests`` is
+False; by default, this setting is True. If additional files
+containing doctests need to be converted, the
+``convert_doctests_2to3``setup option should provide a list of all
+such files.
+
+By default, this conversion uses all fixers in the ``lib2to3.fixes``
+package. To use additional fixes, the list
+``setuptools.lib2to3_fixer_packages`` must be extended with names
+of packages containing fixes. If certain fixes are to be suppressed,
+this again can be overridden with the list 
+``setuptools.commands.build_py.build_py.fixers``, which then contains
+the list of all fixer class names.
+
 
 Automatic Script Creation
 =========================