aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorPaul Ganssle <pganssle@users.noreply.github.com>2018-11-01 14:54:32 -0400
committerGitHub <noreply@github.com>2018-11-01 14:54:32 -0400
commit6ed6fe8def487aa77ee67d5ab3adcb2b66814831 (patch)
treefc08457804f08113e289c696ab9f109d99d126db
parent7a8657aecc041fd04799fdf45df9708f7824fff2 (diff)
parent22bb74122729f7f7735db420ef32b7c578ca0d13 (diff)
downloadexternal_python_setuptools-6ed6fe8def487aa77ee67d5ab3adcb2b66814831.tar.gz
external_python_setuptools-6ed6fe8def487aa77ee67d5ab3adcb2b66814831.tar.bz2
external_python_setuptools-6ed6fe8def487aa77ee67d5ab3adcb2b66814831.zip
Merge pull request #1564 from 0az/doc-setup-cfg-min-version
Document setup.cfg minimum version for version and project_urls
-rw-r--r--changelog.d/1564.doc.rst1
-rw-r--r--docs/setuptools.txt23
2 files changed, 14 insertions, 10 deletions
diff --git a/changelog.d/1564.doc.rst b/changelog.d/1564.doc.rst
new file mode 100644
index 00000000..37494a26
--- /dev/null
+++ b/changelog.d/1564.doc.rst
@@ -0,0 +1 @@
+Document setup.cfg minimum version for version and project_urls
diff --git a/docs/setuptools.txt b/docs/setuptools.txt
index a1cdce1b..0edd68fa 100644
--- a/docs/setuptools.txt
+++ b/docs/setuptools.txt
@@ -2357,14 +2357,14 @@ Metadata
The aliases given below are supported for compatibility reasons,
but their use is not advised.
-============================== ================= ================= ===============
-Key Aliases Type Minumum Version
-============================== ================= ================= ===============
+============================== ================= ================= =============== =====
+Key Aliases Type Minumum Version Notes
+============================== ================= ================= =============== =====
name str
-version attr:, file:, str
+version attr:, file:, str 39.2.0 (1)
url home-page str
download_url download-url str
-project_urls dict
+project_urls dict 38.3.0
author str
author_email author-email str
maintainer str
@@ -2379,19 +2379,22 @@ platforms platform list-comma
provides list-comma
requires list-comma
obsoletes list-comma
-============================== ================= ================= ===============
+============================== ================= ================= =============== =====
.. note::
A version loaded using the ``file:`` directive must comply with PEP 440.
It is easy to accidentally put something other than a valid version
string in such a file, so validation is stricter in this case.
+Notes:
+1. The `version` file attribute has only been supported since 39.2.0.
+
Options
-------
-======================= =================================== =====
-Key Type Minimum Version
-======================= =================================== =====
+======================= =================================== =============== =====
+Key Type Minimum Version Notes
+======================= =================================== =============== =====
zip_safe bool
setup_requires list-semi
install_requires list-semi
@@ -2414,7 +2417,7 @@ exclude_package_data section
namespace_packages list-comma
py_modules list-comma
data_files dict 40.5.0
-======================= =================================== =====
+======================= =================================== =============== =====
.. note::