Skip to content

Commit e548d9f

Browse files
author
Jon Wayne Parrott
authored
Mention requirement of 'wheel' package for creating wheels (pypa#299)
1 parent 14f3288 commit e548d9f

File tree

1 file changed

+18
-13
lines changed

1 file changed

+18
-13
lines changed

source/distributing.rst

Lines changed: 18 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -613,41 +613,46 @@ end user than installing from a source distribution.
613613

614614
If your project is pure python (i.e. contains no compiled extensions) and
615615
natively supports both Python 2 and 3, then you'll be creating what's called a
616-
:ref:`"Universal Wheel" (see section below) <Universal Wheels>`.
616+
:ref:`*Universal Wheel* (see section below) <Universal Wheels>`.
617617

618618
If your project is pure python but does not natively support both Python 2 and
619619
3, then you'll be creating a :ref:`"Pure Python Wheel" (see section below) <Pure
620620
Python Wheels>`.
621621

622622
If you project contains compiled extensions, then you'll be creating what's
623-
called a :ref:`"Platform Wheel" (see section below) <Platform Wheels>`.
623+
called a :ref:`*Platform Wheel* (see section below) <Platform Wheels>`.
624+
625+
Before you can build wheels for your project, you'll need to install the
626+
``wheel`` package:
627+
628+
.. code-block:: text
629+
630+
pip install wheel
624631
625632
626633
.. _`Universal Wheels`:
627634

628635
Universal Wheels
629636
~~~~~~~~~~~~~~~~
630637

631-
"Universal Wheels" are wheels that are pure python (i.e. contains no compiled
638+
*Universal Wheels* are wheels that are pure python (i.e. contains no compiled
632639
extensions) and support Python 2 and 3. This is a wheel that can be installed
633640
anywhere by :ref:`pip`.
634641

635-
To build a Universal Wheel:
636-
637-
::
642+
To build the wheel:
638643

639-
python setup.py bdist_wheel --universal
644+
.. code-block:: text
640645
646+
python setup.py bdist_wheel --universal
641647
642648
You can also permanently set the ``--universal`` flag in "setup.cfg" (e.g., see
643649
`sampleproject/setup.cfg
644650
<https://github.com/pypa/sampleproject/blob/master/setup.cfg>`_)
645651

646-
::
647-
648-
[bdist_wheel]
649-
universal=1
652+
.. code-block:: text
650653
654+
[bdist_wheel]
655+
universal=1
651656
652657
Only use the ``--universal`` setting, if:
653658

@@ -668,7 +673,7 @@ and prevent the possibility of building the extension.
668673
Pure Python Wheels
669674
~~~~~~~~~~~~~~~~~~
670675

671-
"Pure Python Wheels" that are not "universal" are wheels that are pure python
676+
*Pure Python Wheels* that are not "universal" are wheels that are pure python
672677
(i.e. contains no compiled extensions), but don't natively support both Python 2
673678
and 3.
674679

@@ -696,7 +701,7 @@ will produce wheels for each version.
696701
Platform Wheels
697702
~~~~~~~~~~~~~~~
698703

699-
"Platform Wheels" are wheels that are specific to a certain platform like linux,
704+
*Platform Wheels* are wheels that are specific to a certain platform like linux,
700705
OSX, or Windows, usually due to containing compiled extensions.
701706

702707
To build the wheel:

0 commit comments

Comments
 (0)