Skip to content

Commit

Permalink
Docs: Link directly to PEPs (#3770)
Browse files Browse the repository at this point in the history
  • Loading branch information
abravalheri committed Jan 20, 2023
2 parents f45c54a + 20efb6f commit d348fdf
Show file tree
Hide file tree
Showing 4 changed files with 4 additions and 7 deletions.
3 changes: 1 addition & 2 deletions docs/artwork.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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
2 changes: 1 addition & 1 deletion docs/build_meta.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down
4 changes: 1 addition & 3 deletions docs/deprecated/easy_install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/userguide/package_discovery.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit d348fdf

Please sign in to comment.