summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJason R. Coombs <jaraco@jaraco.com>2022-03-19 09:10:41 -0400
committerJason R. Coombs <jaraco@jaraco.com>2022-03-19 09:10:41 -0400
commite109eff86e98c0570a5c86f83e470ea942aab5a5 (patch)
tree545e4bf2ac7584e2921151eba4b6d2a25e1c5ce3
parentddca7988e951021340ee445994d3c6c55a957eee (diff)
downloadpython-setuptools-git-e109eff86e98c0570a5c86f83e470ea942aab5a5.tar.gz
Fix warnings for pypi references.
-rw-r--r--CHANGES.rst14
-rw-r--r--changelog.d/README.rst3
-rw-r--r--docs/deprecated/easy_install.rst7
-rw-r--r--docs/pkg_resources.rst4
-rw-r--r--docs/userguide/entry_point.rst2
-rw-r--r--docs/userguide/extension.rst4
-rw-r--r--docs/userguide/quickstart.rst2
7 files changed, 15 insertions, 21 deletions
diff --git a/CHANGES.rst b/CHANGES.rst
index 3c724e47..9d1e22f1 100644
--- a/CHANGES.rst
+++ b/CHANGES.rst
@@ -718,7 +718,7 @@ Changes
``license_file`` (deprecated) and ``license_files`` options,
relative to ``.dist-info``. - by :user:`cdce8p`
* #2678: Moved Setuptools' own entry points into declarative config.
-* #2680: Vendored `more_itertools <https://pypi.org/project/more-itertools>`_ for Setuptools.
+* #2680: Vendored :pypi:`more_itertools` for Setuptools.
* #2681: Setuptools own setup.py no longer declares setup_requires, but instead expects wheel to be installed as declared by pyproject.toml.
Misc
@@ -1646,7 +1646,7 @@ Breaking Changes
* eggs are not supported
* no support for the ``allow_hosts`` easy_install option (``index_url``/``find_links`` are still honored)
* pip environment variables are honored (and take precedence over easy_install options)
-* #1898: Removed the "upload" and "register" commands in favor of `twine <https://pypi.org/p/twine>`_.
+* #1898: Removed the "upload" and "register" commands in favor of :pypi:`twine`.
Changes
^^^^^^^
@@ -1656,7 +1656,7 @@ Changes
* add support for manylinux2010
* fix use of removed 'm' ABI flag in Python 3.8 on Windows
* #1861: Fix empty namespace package installation from wheel.
-* #1877: Setuptools now exposes a new entry point hook "setuptools.finalize_distribution_options", enabling plugins like `setuptools_scm <https://pypi.org/project/setuptools_scm>`_ to configure options on the distribution at finalization time.
+* #1877: Setuptools now exposes a new entry point hook "setuptools.finalize_distribution_options", enabling plugins like :pypi:`setuptools_scm` to configure options on the distribution at finalization time.
v41.6.0
@@ -2923,7 +2923,7 @@ v26.1.0
-------
* #763: ``pkg_resources.get_default_cache`` now defers to the
- `appdirs project <https://pypi.org/project/appdirs>`_ to
+ :pypi:`appdirs` project to
resolve the cache directory. Adds a vendored dependency on
appdirs to pkg_resources.
@@ -3915,8 +3915,7 @@ process to fail and PyPI uploads no longer accept files for 13.0.
* Issue #313: Removed built-in support for subversion. Projects wishing to
retain support for subversion will need to use a third party library. The
- extant implementation is being ported to `setuptools_svn
- <https://pypi.org/project/setuptools_svn/>`_.
+ extant implementation is being ported to :pypi:`setuptools_svn`.
* Issue #315: Updated setuptools to hide its own loaded modules during
installation of another package. This change will enable setuptools to
upgrade (or downgrade) itself even when its own metadata and implementation
@@ -4420,8 +4419,7 @@ process to fail and PyPI uploads no longer accept files for 13.0.
* Address security vulnerability in SSL match_hostname check as reported in
Python #17997.
-* Prefer `backports.ssl_match_hostname
- <https://pypi.org/project/backports.ssl_match_hostname/>`_ for backport
+* Prefer :pypi:`backports.ssl_match_hostname` for backport
implementation if present.
* Correct NameError in ``ssl_support`` module (``socket.error``).
diff --git a/changelog.d/README.rst b/changelog.d/README.rst
index 49b4d563..6def76b5 100644
--- a/changelog.d/README.rst
+++ b/changelog.d/README.rst
@@ -21,8 +21,7 @@ recorded in the Git history rather than a changelog.
Alright! So how to add a news fragment?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-``setuptools`` uses `towncrier <https://pypi.org/project/towncrier/>`_
-for changelog management.
+``setuptools`` uses :pypi:`towncrier` for changelog management.
To submit a change note about your PR, add a text file into the
``changelog.d/`` folder. It should contain an
explanation of what applying this PR will change in the way
diff --git a/docs/deprecated/easy_install.rst b/docs/deprecated/easy_install.rst
index 76c3f608..3cf3bea9 100644
--- a/docs/deprecated/easy_install.rst
+++ b/docs/deprecated/easy_install.rst
@@ -34,7 +34,7 @@ Using "Easy Install"
Installing "Easy Install"
-------------------------
-Please see the `setuptools PyPI page <https://pypi.org/project/setuptools/>`_
+Please see the :pypi:`setuptools` on the package index
for download links and basic installation instructions for each of the
supported platforms.
@@ -1020,10 +1020,7 @@ of the User installation scheme. "virtualenv" provides a version of ``easy_inst
scoped to the cloned python install and is used in the normal way. "virtualenv" does offer various features
that the User installation scheme alone does not provide, e.g. the ability to hide the main python site-packages.
-Please refer to the `virtualenv`_ documentation for more details.
-
-.. _virtualenv: https://pypi.org/project/virtualenv/
-
+Please refer to the :pypi:`virtualenv` documentation for more details.
Package Index "API"
diff --git a/docs/pkg_resources.rst b/docs/pkg_resources.rst
index c1158189..21ff6dc1 100644
--- a/docs/pkg_resources.rst
+++ b/docs/pkg_resources.rst
@@ -13,8 +13,8 @@ packages.
Use of ``pkg_resources`` is discouraged in favor of
`importlib.resources <https://docs.python.org/3/library/importlib.html#module-importlib.resources>`_,
`importlib.metadata <https://docs.python.org/3/library/importlib.metadata.html>`_,
-and their backports (`resources <https://pypi.org/project/importlib_resources>`_,
-`metadata <https://pypi.org/project/importlib_metadata>`_).
+and their backports (:pypi:`importlib_resources`,
+:pypi:`importlib_metadata`).
Please consider using those libraries instead of pkg_resources.
diff --git a/docs/userguide/entry_point.rst b/docs/userguide/entry_point.rst
index ea73bb5e..b97419c4 100644
--- a/docs/userguide/entry_point.rst
+++ b/docs/userguide/entry_point.rst
@@ -120,7 +120,7 @@ and tools like ``pip`` create wrapper scripts that invoke those commands.
For a project wishing to solicit entry points, Setuptools recommends the
`importlib.metadata <https://docs.python.org/3/library/importlib.metadata.html>`_
module (part of stdlib since Python 3.8) or its backport,
-`importlib_metadata <https://pypi.org/project/importlib_metadata>`_.
+:pypi:`importlib_metadata`.
For example, to find the console script entry points from the example above:
diff --git a/docs/userguide/extension.rst b/docs/userguide/extension.rst
index d74ca3fe..21fb05b6 100644
--- a/docs/userguide/extension.rst
+++ b/docs/userguide/extension.rst
@@ -194,8 +194,8 @@ Adding Support for Revision Control Systems
If the files you want to include in the source distribution are tracked using
Git, Mercurial or SVN, you can use the following packages to achieve that:
-- Git and Mercurial: `setuptools_scm <https://pypi.org/project/setuptools_scm/>`_
-- SVN: `setuptools_svn <https://pypi.org/project/setuptools_svn/>`_
+- Git and Mercurial: :pypi:`setuptools_scm`
+- SVN: :pypi:`setuptools_svn`
If you would like to create a plugin for ``setuptools`` to find files tracked
by another revision control system, you can do so by adding an entry point to
diff --git a/docs/userguide/quickstart.rst b/docs/userguide/quickstart.rst
index f3183624..4fb59b14 100644
--- a/docs/userguide/quickstart.rst
+++ b/docs/userguide/quickstart.rst
@@ -211,7 +211,7 @@ Uploading your package to PyPI
==============================
After generating the distribution files, the next step would be to upload your
distribution so others can use it. This functionality is provided by
-`twine <https://pypi.org/project/twine/>`_ and we will only demonstrate the
+:pypi:`twine` and we will only demonstrate the
basic use here.