Merge branch 'master' into feature/re-vendor-sadface

3 files changed, 40 insertions, 46 deletions

diff --git a/docs/conf.py b/docs/conf.py
index fe684271..f7d02303 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -18,18 +18,23 @@
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 
-# Allow Sphinx to find the setup command that is imported below, as referenced above.
-import os
+import subprocess
 import sys
-sys.path.append(os.path.abspath('..'))
+import os
+
 
-import setup as setup_script
+# hack to run the bootstrap script so that jaraco.packaging.sphinx
+# can invoke setup.py
+'READTHEDOCS' in os.environ and subprocess.check_call(
+    [sys.executable, 'bootstrap.py'],
+    cwd=os.path.join(os.path.dirname(__file__), os.path.pardir),
+)
 
 # -- General configuration -----------------------------------------------------
 
 # Add any Sphinx extension module names here, as strings. They can be extensions
 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
-extensions = ['rst.linker', 'sphinx.ext.autosectionlabel']
+extensions = ['jaraco.packaging.sphinx', 'rst.linker', 'sphinx.ext.autosectionlabel']
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
@@ -40,19 +45,6 @@ source_suffix = '.txt'
 # The master toctree document.
 master_doc = 'index'
 
-# General information about the project.
-project = 'Setuptools'
-copyright = '2009-2014, The fellowship of the packaging'
-
-# The version info for the project you're documenting, acts as replacement for
-# |version| and |release|, also used in various other places throughout the
-# built documents.
-#
-# The short X.Y version.
-version = setup_script.setup_params['version']
-# The full version, including alpha/beta/rc tags.
-release = setup_script.setup_params['version']
-
 # List of directories, relative to source directory, that shouldn't be searched
 # for source files.
 exclude_trees = []
@@ -69,13 +61,6 @@ html_theme = 'nature'
 # Add any paths that contain custom themes here, relative to this directory.
 html_theme_path = ['_theme']
 
-# The name for this set of Sphinx documents.  If None, it defaults to
-# "<project> v<release> documentation".
-html_title = "Setuptools documentation"
-
-# A shorter title for the navigation bar.  Default is the same as html_title.
-html_short_title = "Setuptools"
-
 # If true, SmartyPants will be used to convert quotes and dashes to
 # typographically correct entities.
 html_use_smartypants = True
@@ -89,9 +74,6 @@ html_use_modindex = False
 # If false, no index is generated.
 html_use_index = False
 
-# Output file base name for HTML help builder.
-htmlhelp_basename = 'Setuptoolsdoc'
-
 # -- Options for LaTeX output --------------------------------------------------
 
 # Grouping the document tree into LaTeX files. List of tuples
@@ -109,60 +91,60 @@ link_files = {
         ),
         replace=[
             dict(
-                pattern=r"(Issue )?#(?P<issue>\d+)",
-                url='{GH}/pypa/setuptools/issues/{issue}',
+                pattern=r'(Issue )?#(?P<issue>\d+)',
+                url='{package_url}/issues/{issue}',
             ),
             dict(
-                pattern=r"BB Pull Request ?#(?P<bb_pull_request>\d+)",
+                pattern=r'BB Pull Request ?#(?P<bb_pull_request>\d+)',
                 url='{BB}/pypa/setuptools/pull-request/{bb_pull_request}',
             ),
             dict(
-                pattern=r"Distribute #(?P<distribute>\d+)",
+                pattern=r'Distribute #(?P<distribute>\d+)',
                 url='{BB}/tarek/distribute/issue/{distribute}',
             ),
             dict(
-                pattern=r"Buildout #(?P<buildout>\d+)",
+                pattern=r'Buildout #(?P<buildout>\d+)',
                 url='{GH}/buildout/buildout/issues/{buildout}',
             ),
             dict(
-                pattern=r"Old Setuptools #(?P<old_setuptools>\d+)",
+                pattern=r'Old Setuptools #(?P<old_setuptools>\d+)',
                 url='http://bugs.python.org/setuptools/issue{old_setuptools}',
             ),
             dict(
-                pattern=r"Jython #(?P<jython>\d+)",
+                pattern=r'Jython #(?P<jython>\d+)',
                 url='http://bugs.jython.org/issue{jython}',
             ),
             dict(
-                pattern=r"Python #(?P<python>\d+)",
+                pattern=r'Python #(?P<python>\d+)',
                 url='http://bugs.python.org/issue{python}',
             ),
             dict(
-                pattern=r"Interop #(?P<interop>\d+)",
+                pattern=r'Interop #(?P<interop>\d+)',
                 url='{GH}/pypa/interoperability-peps/issues/{interop}',
             ),
             dict(
-                pattern=r"Pip #(?P<pip>\d+)",
+                pattern=r'Pip #(?P<pip>\d+)',
                 url='{GH}/pypa/pip/issues/{pip}',
             ),
             dict(
-                pattern=r"Packaging #(?P<packaging>\d+)",
+                pattern=r'Packaging #(?P<packaging>\d+)',
                 url='{GH}/pypa/packaging/issues/{packaging}',
             ),
             dict(
-                pattern=r"[Pp]ackaging (?P<packaging_ver>\d+(\.\d+)+)",
+                pattern=r'[Pp]ackaging (?P<packaging_ver>\d+(\.\d+)+)',
                 url='{GH}/pypa/packaging/blob/{packaging_ver}/CHANGELOG.rst',
             ),
             dict(
-                pattern=r"PEP[- ](?P<pep_number>\d+)",
+                pattern=r'PEP[- ](?P<pep_number>\d+)',
                 url='https://www.python.org/dev/peps/pep-{pep_number:0>4}/',
             ),
             dict(
-                pattern=r"setuptools_svn #(?P<setuptools_svn>\d+)",
+                pattern=r'setuptools_svn #(?P<setuptools_svn>\d+)',
                 url='{GH}/jaraco/setuptools_svn/issues/{setuptools_svn}',
             ),
             dict(
-                pattern=r"^(?m)((?P<scm_version>v?\d+(\.\d+){1,2}))\n[-=]+\n",
-                with_scm="{text}\n{rev[timestamp]:%d %b %Y}\n",
+                pattern=r'^(?m)((?P<scm_version>v?\d+(\.\d+){1,2}))\n[-=]+\n',
+                with_scm='{text}\n{rev[timestamp]:%d %b %Y}\n',
             ),
         ],
     ),
diff --git a/docs/requirements.txt b/docs/requirements.txt
index 4be41887..2138c884 100644
--- a/docs/requirements.txt
+++ b/docs/requirements.txt
@@ -1,2 +1,5 @@
-rst.linker>=1.6.1
-sphinx>=1.4
+sphinx
+rst.linker>=1.9
+jaraco.packaging>=3.2
+
+setuptools>=34
diff --git a/docs/setuptools.txt b/docs/setuptools.txt
index f0da6e1d..eb9fdbd3 100644
--- a/docs/setuptools.txt
+++ b/docs/setuptools.txt
@@ -1176,6 +1176,8 @@ Distributing a ``setuptools``-based project
 Using ``setuptools``...  Without bundling it!
 ---------------------------------------------
 
+.. warning:: **ez_setup** is deprecated in favor of PIP with **PEP-518** support.
+
 Your users might not have ``setuptools`` installed on their machines, or even
 if they do, it might not be the right version.  Fixing this is easy; just
 download `ez_setup.py`_, and put it in the same directory as your ``setup.py``
@@ -2277,6 +2279,11 @@ New in 20.1: Added keyring support.
 Configuring setup() using setup.cfg files
 -----------------------------------------
 
+.. note:: New in 30.3.0 (8 Dec 2016).
+
+.. important:: ``setup.py`` with ``setup()`` function call is still required even 
+                if your configuration resides in ``setup.cfg``.
+
 ``Setuptools`` allows using configuration files (usually `setup.cfg`)
 to define package’s metadata and other options which are normally supplied
 to ``setup()`` function.
@@ -2425,6 +2432,7 @@ zip_safe                 bool
 setup_requires           list-semi
 install_requires         list-semi
 extras_require           section
+python_requires          str
 entry_points             file:, section
 use_2to3                 bool
 use_2to3_fixers          list-comma
@@ -2440,6 +2448,7 @@ package_dir              dict
 package_data             section
 exclude_package_data     section
 namespace_packages       list-comma
+py_modules               list-comma
 =======================  =====
 
 .. note::