diff options
| author | Anderson Bravalheri <andersonbravalheri@gmail.com> | 2022-03-21 08:43:51 +0000 |
|---|---|---|
| committer | Anderson Bravalheri <andersonbravalheri@gmail.com> | 2022-03-21 08:43:51 +0000 |
| commit | c6531bc5bef4ac3937880f416b3148e7e0182da0 (patch) | |
| tree | d64815368d5fd68e47520829660a2547b8c6421c /docs | |
| parent | 533115f08eab629a4f92c0f9f5f8d296153cd765 (diff) | |
| parent | 8723db46613fc2a010acf468a8d50257d1c0e76b (diff) | |
| download | python-setuptools-git-c6531bc5bef4ac3937880f416b3148e7e0182da0.tar.gz | |
Merge 'upstream/main' into experimental/support-pyproject
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/deprecated/easy_install.rst | 7 | ||||
| -rw-r--r-- | docs/deprecated/index.rst | 1 | ||||
| -rw-r--r-- | docs/pkg_resources.rst | 4 | ||||
| -rw-r--r-- | docs/userguide/entry_point.rst | 2 | ||||
| -rw-r--r-- | docs/userguide/extension.rst | 4 |
5 files changed, 7 insertions, 11 deletions
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/deprecated/index.rst b/docs/deprecated/index.rst index ce2ac006..59fc7bef 100644 --- a/docs/deprecated/index.rst +++ b/docs/deprecated/index.rst @@ -13,7 +13,6 @@ objectives. .. toctree:: :maxdepth: 1 - python3 python_eggs easy_install distutils/index 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 |
