summaryrefslogtreecommitdiffstats
path: root/Doc
diff options
context:
space:
mode:
authorRyan Gonzalez <kirbyfan64@users.noreply.github.com>2017-04-14 09:00:25 (GMT)
committerVictor Stinner <victor.stinner@gmail.com>2017-04-14 09:00:25 (GMT)
commitf9f87f0934ca570293ba7194bed3448a7f9bf39c (patch)
tree7c59d528dd172d6b331ce0ab0afdfaf687f75318 /Doc
parent947629916a5ecb1f6f6792e9b9234e084c5bf274 (diff)
downloadcpython-f9f87f0934ca570293ba7194bed3448a7f9bf39c.zip
cpython-f9f87f0934ca570293ba7194bed3448a7f9bf39c.tar.gz
cpython-f9f87f0934ca570293ba7194bed3448a7f9bf39c.tar.bz2
bpo-11913: Add README.rst to the distutils standard READMEs list (#563)
Diffstat (limited to 'Doc')
-rw-r--r--Doc/distutils/sourcedist.rst8
-rw-r--r--Doc/whatsnew/3.7.rst7
2 files changed, 13 insertions, 2 deletions
diff --git a/Doc/distutils/sourcedist.rst b/Doc/distutils/sourcedist.rst
index cc289c9..0ac8ef4 100644
--- a/Doc/distutils/sourcedist.rst
+++ b/Doc/distutils/sourcedist.rst
@@ -95,8 +95,9 @@ 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`
+* Any of the standard README files (:file:`README`, :file:`README.txt`,
+ or :file:`README.rst`), :file:`setup.py` (or whatever you called your setup
+ script), and :file:`setup.cfg`.
* all files that matches the ``package_data`` metadata.
See :ref:`distutils-installing-package-data`.
@@ -130,6 +131,9 @@ described above does not apply in this case.
:command:`sdist` will read a :file:`MANIFEST` file if no :file:`MANIFEST.in`
exists, like it used to do.
+.. versionchanged:: 3.7
+ :file:`README.rst` is now included in the list of distutils standard READMEs.
+
The manifest template has one command per line, where each command specifies a
set of files to include or exclude from the source distribution. For an
diff --git a/Doc/whatsnew/3.7.rst b/Doc/whatsnew/3.7.rst
index b5107ea..875fc55 100644
--- a/Doc/whatsnew/3.7.rst
+++ b/Doc/whatsnew/3.7.rst
@@ -95,6 +95,13 @@ New Modules
Improved Modules
================
+distutils
+---------
+
+README.rst is now included in the list of distutils standard READMEs and
+therefore included in source distributions.
+(Contributed by Ryan Gonzalez in :issue:`11913`.)
+
http.server
-----------