aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorJason R. Coombs <jaraco@jaraco.com>2019-10-26 16:36:07 -0400
committerJason R. Coombs <jaraco@jaraco.com>2019-10-26 16:36:07 -0400
commitc11270aa6bffd8913c6e074f09b9d920c8f19002 (patch)
tree5c97e2e05dcabb9b13e954528fa6783740f68fb6 /docs
parent6a3674a18d22dbea4d6b513b8e8a7ac28ada5eba (diff)
parent297f2adceda3af402fc08311e42505c8cdc9c54b (diff)
downloadexternal_python_setuptools-c11270aa6bffd8913c6e074f09b9d920c8f19002.tar.gz
external_python_setuptools-c11270aa6bffd8913c6e074f09b9d920c8f19002.tar.bz2
external_python_setuptools-c11270aa6bffd8913c6e074f09b9d920c8f19002.zip
Merge branch 'master' into fix/1700
Diffstat (limited to 'docs')
-rw-r--r--docs/conf.py2
-rw-r--r--docs/developer-guide.txt14
-rw-r--r--docs/keywords.txt6
-rw-r--r--docs/setuptools.txt29
4 files changed, 44 insertions, 7 deletions
diff --git a/docs/conf.py b/docs/conf.py
index c7eb6d3f..cbd19fb4 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -69,7 +69,7 @@ html_theme_path = ['_theme']
html_use_smartypants = True
# Custom sidebar templates, maps document names to template names.
-html_sidebars = {'index': 'indexsidebar.html'}
+html_sidebars = {'index': ['relations.html', 'sourcelink.html', 'indexsidebar.html', 'searchbox.html']}
# If false, no module index is generated.
html_use_modindex = False
diff --git a/docs/developer-guide.txt b/docs/developer-guide.txt
index a5942c8b..d145fba1 100644
--- a/docs/developer-guide.txt
+++ b/docs/developer-guide.txt
@@ -137,3 +137,17 @@ To build the docs locally, use tox::
.. _Sphinx: http://www.sphinx-doc.org/en/master/
.. _published documentation: https://setuptools.readthedocs.io/en/latest/
+
+---------------------
+Vendored Dependencies
+---------------------
+
+Setuptools has some dependencies, but due to `bootstrapping issues
+<https://github.com/pypa/setuptools/issues/980>`, those dependencies
+cannot be declared as they won't be resolved soon enough to build
+setuptools from source. Eventually, this limitation may be lifted as
+PEP 517/518 reach ubiquitous adoption, but for now, Setuptools
+cannot declare dependencies other than through
+``setuptools/_vendor/vendored.txt`` and
+``pkg_reosurces/_vendor/vendored.txt`` and refreshed by way of
+``paver update_vendored`` (pavement.py).
diff --git a/docs/keywords.txt b/docs/keywords.txt
index d56014e0..56356190 100644
--- a/docs/keywords.txt
+++ b/docs/keywords.txt
@@ -259,6 +259,8 @@
specified test suite, e.g. via ``setup.py test``. See the section on the
:ref:`test` command below for more details.
+ New in 41.5.0: Deprecated the test command.
+
``tests_require``
If your project's tests need one or more additional packages besides those
needed to install it, you can use this option to specify them. It should
@@ -270,6 +272,8 @@
are run, but only downloaded to the project's setup directory if they're
not already installed locally.
+ New in 41.5.0: Deprecated the test command.
+
.. _test_loader:
``test_loader``
@@ -293,6 +297,8 @@
as long as you use the ``tests_require`` option to ensure that the package
containing the loader class is available when the ``test`` command is run.
+ New in 41.5.0: Deprecated the test command.
+
``eager_resources``
A list of strings naming resources that should be extracted together, if
any of them is needed, or if any C extensions included in the project are
diff --git a/docs/setuptools.txt b/docs/setuptools.txt
index ae85b8f5..ce022ac1 100644
--- a/docs/setuptools.txt
+++ b/docs/setuptools.txt
@@ -136,16 +136,18 @@ dependencies, and perhaps some data files and scripts::
author="Me",
author_email="me@example.com",
description="This is an Example Package",
- license="PSF",
keywords="hello world example examples",
url="http://example.com/HelloWorld/", # project home page, if any
project_urls={
"Bug Tracker": "https://bugs.example.com/HelloWorld/",
"Documentation": "https://docs.example.com/HelloWorld/",
"Source Code": "https://code.example.com/HelloWorld/",
- }
+ },
+ classifiers=[
+ 'License :: OSI Approved :: Python Software Foundation License'
+ ]
- # could also include long_description, download_url, classifiers, etc.
+ # could also include long_description, download_url, etc.
)
In the sections that follow, we'll explain what most of these ``setup()``
@@ -242,9 +244,9 @@ pre- or post-release tags. See the following sections for more details:
New and Changed ``setup()`` Keywords
====================================
-The following keyword arguments to ``setup()`` are supported by ``setuptools``.
-Some of them are optional; you do not have to supply them unless you need the
-associated ``setuptools`` feature.
+The following keyword arguments to ``setup()`` are added or changed by
+``setuptools``. All of them are optional; you do not have to supply them
+unless you need the associated ``setuptools`` feature.
.. include:: keywords.txt
@@ -513,6 +515,10 @@ using ``setup.py develop``.)
Dependencies that aren't in PyPI
--------------------------------
+.. warning::
+ Dependency links support has been dropped by pip starting with version
+ 19.0 (released 2019-01-22).
+
If your project depends on packages that don't exist on PyPI, you may still be
able to depend on them, as long as they are available for download as:
@@ -1532,6 +1538,9 @@ file locations.
``bdist_egg`` - Create a Python Egg for the project
===================================================
+.. warning::
+ **eggs** are deprecated in favor of wheels, and not supported by pip.
+
This command generates a Python Egg (``.egg`` file) for the project. Python
Eggs are the preferred binary distribution format for EasyInstall, because they
are cross-platform (for "pure" packages), directly importable, and contain
@@ -1978,6 +1987,11 @@ distutils configuration file the option will be added to (or removed from).
``test`` - Build package and run a unittest suite
=================================================
+.. warning::
+ ``test`` is deprecated and will be removed in a future version. Users
+ looking for a generic test entry point independent of test runner are
+ encouraged to use `tox <https://tox.readthedocs.io>`_.
+
When doing test-driven development, or running automated builds that need
testing before they are deployed for downloading or use, it's often useful
to be able to run a project's unit tests without actually deploying the project
@@ -2023,6 +2037,8 @@ available:
If you did not set a ``test_suite`` in your ``setup()`` call, and do not
provide a ``--test-suite`` option, an error will occur.
+New in 41.5.0: Deprecated the test command.
+
.. _upload:
@@ -2079,6 +2095,7 @@ boilerplate code in some cases.
license = BSD 3-Clause License
classifiers =
Framework :: Django
+ License :: OSI Approved :: BSD License
Programming Language :: Python :: 3
Programming Language :: Python :: 3.5