diff options
| author | Julien Jehannet <julien@smaf.org> | 2011-01-30 10:46:06 +0100 |
|---|---|---|
| committer | Julien Jehannet <julien@smaf.org> | 2011-01-30 10:46:06 +0100 |
| commit | 18a5af3e70a9c293c325ba5a109317716f490e8b (patch) | |
| tree | dcbc431b3c27a54244d8e81cf4053aff57ce75e3 /docs/source | |
| parent | d903c7d07cc06e4f995395473488249f9c1f7b43 (diff) | |
| download | disutils2-18a5af3e70a9c293c325ba5a109317716f490e8b.tar.gz | |
minor: update setupcfg documentation
Diffstat (limited to 'docs/source')
| -rw-r--r-- | docs/source/distutils/sourcedist.rst | 7 | ||||
| -rw-r--r-- | docs/source/setupcfg.rst | 21 |
2 files changed, 20 insertions, 8 deletions
diff --git a/docs/source/distutils/sourcedist.rst b/docs/source/distutils/sourcedist.rst index 1aa722b..7ed9637 100644 --- a/docs/source/distutils/sourcedist.rst +++ b/docs/source/distutils/sourcedist.rst @@ -86,8 +86,7 @@ source distribution: distributions, but in the future there will be a standard for testing Python module distributions) -* :file:`README.txt` (or :file:`README`), :file:`setup.py` (or whatever you - called your setup script), and :file:`setup.cfg` +* The configuration file :file:`setup.cfg` * all files that matches the ``package_data`` metadata. See :ref:`distutils-installing-package-data`. @@ -95,6 +94,10 @@ source distribution: * all files that matches the ``data_files`` metadata. See :ref:`distutils-additional-files`. +.. Warning:: + In Distutils2, setup.py and README (or README.txt) files are not more + included in source distribution by default + Sometimes this is enough, but usually you will want to specify additional files to distribute. The typical way to do this is to write a *manifest template*, called :file:`MANIFEST.in` by default. The manifest template is just a list of diff --git a/docs/source/setupcfg.rst b/docs/source/setupcfg.rst index 7a9bca7..4752ab4 100644 --- a/docs/source/setupcfg.rst +++ b/docs/source/setupcfg.rst @@ -7,8 +7,8 @@ Distutils2 to replace the :file:`setup.py` file. Each section contains a description of its options. -- Options that are marked *\*multi* can have multiple values, one value - per line. +- Options that are marked *\*multi* can have multiple values, one value per + line. - Options that are marked *\*optional* can be omited. - Options that are marked *\*environ* can use environment markers, as described in :PEP:`345`. @@ -49,7 +49,7 @@ Contains global options for Distutils2. This section is shared with Distutils1 *\*optional* *\*multi* - **compilers**: Defined Distutils2 compiler. A compiler is defined by its fully - qualified name. + qualified name. Example:: @@ -66,7 +66,8 @@ Contains global options for Distutils2. This section is shared with Distutils1 Example:: [global] - setup_hook = distutils2.tests.test_config.hook + setup_hook = + distutils2.tests.test_config.hook metadata @@ -142,7 +143,7 @@ Example:: .. Note:: Some metadata fields seen in :PEP:`345` are automatically generated - as the Metadata-Version value for instance. + (for instance Metadata-Version value). files @@ -170,6 +171,14 @@ Example:: extra_files = setup.py + README + +.. Note:: + In Distutils2, setup.cfg will be implicitly included. + +.. Warning:: + In Distutils2, setup.py and README (or README.txt) files are not more + included in source distribution by default `command` sections @@ -183,7 +192,7 @@ Example:: manifest-builders = package.module.Maker -To override the building class in order to compile your python2 files to python3:: +To override the build class in order to generate Python3 code from your Python2 base:: [build_py] use-2to3 = True |
