diff options
author | Anderson Bravalheri <andersonbravalheri@gmail.com> | 2023-01-20 11:12:43 +0000 |
---|---|---|
committer | Anderson Bravalheri <andersonbravalheri@gmail.com> | 2023-01-20 11:12:43 +0000 |
commit | d348fdf51fa725d056fc440175f06de8bec5628c (patch) | |
tree | 405d91caad05aa12b0752d3e1efbad3e6c592f7a /docs | |
parent | f45c54a10438d0ae84d3908ee9d977273e7ad4fa (diff) | |
parent | 20efb6fad4edf47fc56a1bcf44a7d1e5d646d02f (diff) | |
download | python-setuptools-git-d348fdf51fa725d056fc440175f06de8bec5628c.tar.gz |
Docs: Link directly to PEPs (#3770)
Diffstat (limited to 'docs')
-rw-r--r-- | docs/artwork.rst | 3 | ||||
-rw-r--r-- | docs/build_meta.rst | 2 | ||||
-rw-r--r-- | docs/deprecated/easy_install.rst | 4 | ||||
-rw-r--r-- | docs/userguide/package_discovery.rst | 2 |
4 files changed, 4 insertions, 7 deletions
diff --git a/docs/artwork.rst b/docs/artwork.rst index 907e62a6..d815561e 100644 --- a/docs/artwork.rst +++ b/docs/artwork.rst @@ -65,7 +65,7 @@ Inspiration This design was inspired by :user:`cajhne`'s `original proposal`_ and the ancient symbol of the ouroboros_. It features a snake moving in a circular trajectory not only as a reference to -the Python programming language but also to the `wheel package format`_ as one +the Python programming language but also to the :pep:`wheel package format <427>` as one of the distribution formats supported by setuptools. The shape of the snake also resembles a cog, which together with the hammer is a nod to the two words that compose the name of the project. @@ -115,5 +115,4 @@ https://github.com/pypa/setuptools or https://setuptools.pypa.io. .. _setuptools repository: https://github.com/pypa/setuptools .. _install the correct fonts: https://wiki.inkscape.org/wiki/Installing_fonts .. _original proposal: https://github.com/pypa/setuptools/issues/2227#issuecomment-653628344 -.. _wheel package format: https://www.python.org/dev/peps/pep-0427/ .. _ouroboros: https://en.wikipedia.org/wiki/Ouroboros diff --git a/docs/build_meta.rst b/docs/build_meta.rst index 08fd8a7b..197e5917 100644 --- a/docs/build_meta.rst +++ b/docs/build_meta.rst @@ -16,7 +16,7 @@ overhaul. Because ``setup.py`` scripts allow for arbitrary execution, it is difficult to provide a reliable user experience across environments and history. -`PEP 517 <https://www.python.org/dev/peps/pep-0517/>`_ came to +:pep:`517` came to the rescue and specified a new standard for packaging and distributing Python modules. Under PEP 517: diff --git a/docs/deprecated/easy_install.rst b/docs/deprecated/easy_install.rst index 3cf3bea9..ab3d38a0 100644 --- a/docs/deprecated/easy_install.rst +++ b/docs/deprecated/easy_install.rst @@ -989,9 +989,7 @@ The following section lists only the easiest and most relevant approaches [1]_. `Use "virtualenv"`_ -.. [1] There are older ways to achieve custom installation using various ``easy_install`` and ``setup.py install`` options, combined with ``PYTHONPATH`` and/or ``PYTHONUSERBASE`` alterations, but all of these are effectively deprecated by the User scheme brought in by `PEP-370`_. - -.. _PEP-370: http://www.python.org/dev/peps/pep-0370/ +.. [1] There are older ways to achieve custom installation using various ``easy_install`` and ``setup.py install`` options, combined with ``PYTHONPATH`` and/or ``PYTHONUSERBASE`` alterations, but all of these are effectively deprecated by the User scheme brought in by :pep:`370`. Use the "--user" option diff --git a/docs/userguide/package_discovery.rst b/docs/userguide/package_discovery.rst index 7dda84a8..9577a534 100644 --- a/docs/userguide/package_discovery.rst +++ b/docs/userguide/package_discovery.rst @@ -508,7 +508,7 @@ available to your interpreter. Legacy Namespace Packages ========================= The fact you can create namespace packages so effortlessly above is credited -to `PEP 420 <https://www.python.org/dev/peps/pep-0420/>`_. It used to be more +to :pep:`420`. It used to be more cumbersome to accomplish the same result. Historically, there were two methods to create namespace packages. One is the ``pkg_resources`` style supported by ``setuptools`` and the other one being ``pkgutils`` style offered by |